{
"components": {
"responses": {
"ClientError": {
"content": {
"application/vnd.api+json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"code": {
"type": "string"
},
"detail": {
"type": "string"
},
"id": {
"type": "string"
},
"source": {
"properties": {
"parameter": {
"type": "string"
},
"pointer": {
"type": "string"
}
},
"type": "object"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"code",
"title",
"detail"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
}
},
"description": "Client Error"
},
"ServerError": {
"content": {
"application/vnd.api+json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"code": {
"type": "string"
},
"detail": {
"type": "string"
},
"id": {
"type": "string"
},
"source": {
"properties": {
"parameter": {
"type": "string"
},
"pointer": {
"type": "string"
}
},
"type": "object"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"code",
"title",
"detail"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"errors"
],
"type": "object"
}
}
},
"description": "Server Error"
}
},
"schemas": {
"ABTestSendStrategy": {
"properties": {
"method": {
"enum": [
"ab_test_campaign"
],
"type": "string"
}
},
"required": [
"method"
],
"type": "object"
},
"APIJobErrorPayload": {
"properties": {
"code": {
"description": "A code for classifying the error type.",
"example": "invalid",
"type": "string"
},
"detail": {
"description": "Specific details about the error.",
"example": "The payload provided in the request is invalid.",
"type": "string"
},
"id": {
"description": "Unique identifier for the error.",
"example": "e4eebb08-b055-4a6f-bb13-c8cb69c9eb94",
"type": "string"
},
"source": {
"$ref": "#/components/schemas/ErrorSource",
"description": "Additional information on the source of the error."
},
"title": {
"description": "A high-level message about the error.",
"example": "Invalid input",
"type": "string"
}
},
"required": [
"id",
"code",
"title",
"detail",
"source"
],
"type": "object"
},
"APIMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/InStringArrayFilter",
"description": "Optional filter on a specific list of API keys (using last 4 digits of the key)",
"nullable": true
},
"method": {
"enum": [
"api"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"AbTestAction": {
"properties": {
"data": {
"properties": {
"current_experiment": {
"nullable": true,
"properties": {
"allocations": {
"nullable": true,
"type": "object"
},
"automatic_winner_selection_settings": {
"$ref": "#/components/schemas/AutomaticWinnerSelectionSettings",
"nullable": true
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"started": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variations": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/SendEmailAction"
},
{
"$ref": "#/components/schemas/SendSmsAction"
}
]
},
"type": "array"
},
"winner_metric": {
"description": "The metric to use to determine the winner of the A/B test action.\n\nNote that this is different from the metrics used as a flow trigger.",
"enum": [
"submission",
"unique-clicks",
"unique-opens",
"unique-placed-orders"
],
"nullable": true,
"type": "string"
}
},
"required": [
"variations"
],
"type": "object"
},
"experiment_status": {
"default": "draft",
"description": "Not allowed on create.",
"enum": [
"completed",
"draft",
"live"
],
"example": "draft",
"type": "string"
},
"main_action": {
"oneOf": [
{
"$ref": "#/components/schemas/SendEmailAction"
},
{
"$ref": "#/components/schemas/SendSmsAction"
}
]
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"required": [
"main_action"
],
"type": "object"
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"ab-test"
],
"type": "string"
}
},
"required": [
"type",
"data"
],
"type": "object"
},
"AccountEnum": {
"enum": [
"account"
],
"type": "string"
},
"AccountResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"contact_information": {
"$ref": "#/components/schemas/ContactInformation",
"description": "Contact information for the account. This is used in email footers by default to comply with the CAN-SPAM act."
},
"industry": {
"description": "The kind of business and/or types of goods that the business sells. This is leveraged in Klaviyo analytics and guidance.",
"example": "Software / SaaS",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The account's locale is used to determine the region and language for the account.",
"example": "en-US",
"type": "string"
},
"preferred_currency": {
"description": "The preferred currency for the account. This is the currency used for currency-based metrics in dashboards, analytics, coupons, and templates.",
"example": "USD",
"type": "string"
},
"public_api_key": {
"description": "The Public API Key can be used for client-side API calls. [More info here](https://developers.klaviyo.com/en/docs/retrieve_api_credentials).",
"example": "AbC123",
"type": "string"
},
"test_account": {
"description": "Indicates if the account is a test account. Test accounts are not a separate testing engineering environment. Test accounts use the same production environment as normal Klaviyo accounts. This feature is primarily UI based to reduce human errors",
"type": "boolean"
},
"timezone": {
"description": "The account's timezone is used when displaying dates and times. This is an IANA timezone. See [the full list here ](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
"example": "US/Eastern",
"type": "string"
}
},
"required": [
"test_account",
"contact_information",
"timezone",
"preferred_currency",
"public_api_key",
"locale"
],
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/AccountEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"ActionOutputCondition": {
"properties": {
"field": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
},
"output_config_id": {
"type": "integer"
},
"type": {
"enum": [
"action-output"
],
"type": "string"
}
},
"required": [
"type",
"output_config_id",
"field",
"filter"
],
"type": "object"
},
"ActionOutputSplitAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/ActionOutputSplitActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/BooleanBranchLinks",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"action-output-split"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ActionOutputSplitActionData": {
"properties": {
"action_output_filter": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"$ref": "#/components/schemas/ActionOutputCondition"
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
}
},
"required": [
"action_output_filter"
],
"type": "object"
},
"AdditionalField": {
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"AfterCloseTimeout": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/AfterCloseTimeoutProperties"
},
"type": {
"enum": [
"after_close_or_submit_timeout"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"AfterCloseTimeoutProperties": {
"properties": {
"timeout_days": {
"default": 5,
"example": 5,
"type": "integer"
}
},
"type": "object"
},
"AgeGate": {
"properties": {
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/AgeGateProperties"
},
"styles": {
"$ref": "#/components/schemas/AgeGateStyles"
},
"type": {
"enum": [
"age_gate"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"AgeGateProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"date_format": {
"default": "MM/DD/YYYY",
"example": "MM/DD/YYYY",
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"placeholder": {
"nullable": true,
"type": "string"
},
"property_name": {
"default": "$age_gated_date_of_birth",
"enum": [
"$age_gated_date_of_birth"
],
"example": "$age_gated_date_of_birth",
"type": "string"
},
"required": {
"default": true,
"enum": [
true
],
"example": true,
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
},
"sms_country_code": {
"default": "US",
"description": "SMS County Code Enum.",
"enum": [
"AT",
"AU",
"CH",
"DE",
"ES",
"FR",
"GB",
"IE",
"IT",
"PT",
"US"
],
"example": "US",
"type": "string"
}
},
"type": "object"
},
"AgeGateStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"AlltimeDateFilter": {
"properties": {
"operator": {
"description": "Operators for alltime date filters.",
"enum": [
"alltime"
],
"type": "string"
},
"type": {
"enum": [
"date"
],
"type": "string"
}
},
"required": [
"type",
"operator"
],
"type": "object"
},
"AnniversaryDateFilter": {
"properties": {
"operator": {
"description": "Operators for anniversary date filters.",
"enum": [
"anniversary",
"anniversary-month"
],
"type": "string"
},
"type": {
"enum": [
"date"
],
"type": "string"
}
},
"required": [
"type",
"operator"
],
"type": "object"
},
"AttributionEnum": {
"enum": [
"attribution"
],
"type": "string"
},
"AttributionResponseObjectResource": {
"properties": {
"id": {
"description": "The ID of the attribution",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"attributed-event": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Attributed Event",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/EventEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"campaign": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Attributed Campaign",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"campaign-message": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Attributed Campaign Message",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"event": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Event",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/EventEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"flow": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Attributed Flow",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"flow-message": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Attributed Flow Message",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"flow-message-variation": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Attributed Flow Message Variation",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/AttributionEnum"
}
},
"required": [
"type",
"id",
"links"
],
"type": "object"
},
"Audiences": {
"properties": {
"excluded": {
"description": "An optional list of excluded audiences",
"example": [
"UTd5ui"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"included": {
"description": "A list of included audiences",
"example": [
"Y6nRLr"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"included"
],
"type": "object"
},
"AudiencesUpdate": {
"properties": {
"excluded": {
"description": "An optional list of excluded audiences, will override exising excluded audiences",
"example": [
"UTd5ui"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"included": {
"description": "An optional list of included audiences, will override existing included audiences",
"example": [
"Y6nRLr"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"AutomaticWinnerSelectionSettings": {
"properties": {
"automatic_end_date": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"automatic_end_statistical_certainty": {
"type": "boolean"
},
"enabled": {
"type": "boolean"
}
},
"required": [
"enabled",
"automatic_end_statistical_certainty"
],
"type": "object"
},
"BackInStock": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/BackInStockProperties"
},
"type": {
"enum": [
"back_in_stock"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"BackInStockDelayAction": {
"properties": {
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"back-in-stock-delay"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"BackInStockDynamicButtonBorderStyles": {
"properties": {
"color": {
"default": "#000000",
"example": "#000000",
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
},
"style": {
"default": "solid",
"description": "Border pattern enumeration.",
"enum": [
"dashed",
"dotted",
"solid"
],
"example": "solid",
"nullable": true,
"type": "string"
},
"width": {
"default": 1,
"example": 1,
"type": "integer"
}
},
"type": "object"
},
"BackInStockDynamicButtonData": {
"properties": {
"button_styles": {
"$ref": "#/components/schemas/BackInStockDynamicButtonStyles"
},
"display": {
"default": "REPLACE",
"description": "Back In Stock Dynamic Button display type enumeration.",
"enum": [
"NEXT_TO",
"REPLACE"
],
"example": "REPLACE",
"type": "string"
},
"label": {
"default": "",
"type": "string"
},
"text_styles": {
"$ref": "#/components/schemas/BackInStockDynamicButtonTextStyles"
}
},
"type": "object"
},
"BackInStockDynamicButtonDropShadowStyles": {
"properties": {
"blur": {
"default": 15,
"example": 15,
"type": "integer"
},
"color": {
"default": "#000000",
"example": "#000000",
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
},
"x_offset": {
"default": 0,
"type": "integer"
},
"y_offset": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"BackInStockDynamicButtonStyles": {
"properties": {
"alignment": {
"default": "center",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "center",
"type": "string"
},
"border": {
"$ref": "#/components/schemas/BackInStockDynamicButtonBorderStyles"
},
"border_radius": {
"default": 0,
"type": "integer"
},
"color": {
"default": "#000000",
"example": "#000000",
"type": "string"
},
"drop_shadow": {
"$ref": "#/components/schemas/BackInStockDynamicButtonDropShadowStyles"
},
"height": {
"default": 44,
"example": 44,
"type": "integer"
},
"width": {
"default": "fullWidth",
"description": "Back In Stock Dynamic Button display type enumeration.",
"enum": [
"fitToText",
"fullWidth"
],
"example": "fullWidth",
"type": "string"
}
},
"type": "object"
},
"BackInStockDynamicButtonTextStyles": {
"properties": {
"font_color": {
"default": "#FFFFFF",
"example": "#FFFFFF",
"type": "string"
},
"font_family": {
"default": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"example": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"oneOf": [
{
"description": "Web safe font enumeration.",
"enum": [
"Arial Black,Arial",
"Arial, 'Helvetica Neue', Helvetica, sans-serif",
"Century Gothic,AppleGothic,Arial",
"Comic Sans MS,Comic Sans,cursive",
"Courier",
"Courier New",
"Geneva,Arial",
"Georgia",
"Helvetica,Arial",
"Lucida Grande,Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"Lucida,Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"MS Serif,Georgia",
"New York,Georgia",
"Palatino Linotype,Palatino,Georgia",
"Palatino,Georgia",
"Tahoma,sans-serif",
"Times New Roman",
"Trebuchet MS",
"Verdana"
],
"type": "string"
},
{
"type": "string"
}
]
},
"font_size": {
"default": 16,
"example": 16,
"type": "integer"
},
"font_style": {
"nullable": true,
"type": "string"
},
"font_weight": {
"default": 400,
"description": "Font weight enumeration.",
"enum": [
100,
200,
300,
400,
500,
600,
700,
800,
900
],
"example": 400,
"nullable": true,
"type": "integer"
},
"letter_spacing": {
"default": 0,
"type": "integer"
},
"text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"BackInStockEmailConsentCheckbox": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/BackInStockEmailConsentCheckboxProperties"
},
"styles": {
"$ref": "#/components/schemas/BackInStockEmailConsentCheckboxStyles"
},
"type": {
"enum": [
"bis_promotional_email_checkbox"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"BackInStockEmailConsentCheckboxProperties": {
"properties": {
"checkbox_text": {
"type": "string"
},
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"placeholder": {
"enum": [
null
]
},
"property_name": {
"default": "opt_in_promotional_email",
"enum": [
"opt_in_promotional_email"
],
"example": "opt_in_promotional_email",
"type": "string"
},
"required": {
"default": false,
"enum": [
false
],
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
}
},
"required": [
"checkbox_text"
],
"type": "object"
},
"BackInStockEmailConsentCheckboxStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"horizontal_alignment": {
"default": "left",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "left",
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"BackInStockMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"back_in_stock"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"BackInStockProperties": {
"properties": {
"tag_allowlist": {
"items": {
"type": "string"
},
"type": "array"
},
"tag_blocklist": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"BackInStockSubscriptionEnum": {
"enum": [
"back-in-stock-subscription"
],
"type": "string"
},
"BackgroundImage": {
"properties": {
"properties": {
"$ref": "#/components/schemas/ImageAssetProperties"
},
"styles": {
"$ref": "#/components/schemas/BackgroundImageStyles"
}
},
"required": [
"properties"
],
"type": "object"
},
"BackgroundImageStyles": {
"properties": {
"custom_width": {
"nullable": true,
"type": "integer"
},
"horizontal_alignment": {
"default": "center",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "center",
"type": "string"
},
"position": {
"default": "contain",
"description": "Image position enumeration.",
"enum": [
"contain",
"cover",
"custom"
],
"example": "contain",
"type": "string"
},
"vertical_alignment": {
"default": "center",
"description": "Vertical alignment enumeration.",
"enum": [
"bottom",
"center",
"top"
],
"example": "center",
"type": "string"
},
"width": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"BannerStyles": {
"properties": {
"desktop_position": {
"default": "top",
"description": "Positioning of banner forms.",
"enum": [
"bottom",
"top"
],
"example": "top",
"type": "string"
},
"mobile_position": {
"default": "top",
"description": "Positioning of banner forms.",
"enum": [
"bottom",
"top"
],
"example": "top",
"type": "string"
},
"scroll_with_page": {
"default": true,
"example": true,
"type": "boolean"
}
},
"type": "object"
},
"BaseEventCreateQueryBulkEntryResourceObject": {
"properties": {
"attributes": {
"properties": {
"backfill": {
"default": false,
"description": "When true, the event is recorded but does NOT trigger flows. Use this when backfilling\nhistorical events so existing flow definitions do not re-fire on events that already\nfired in the past.",
"nullable": true,
"type": "boolean"
},
"metric": {
"properties": {
"data": {
"$ref": "#/components/schemas/MetricCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"properties": {
"description": "Properties of this event (must not exceed 400 properties). The size of the event payload must not exceed 5 MB,\nand each string cannot be larger than 100 KB. For a full list of data limits on event payloads,\nsee [Limitations](https://developers.klaviyo.com/en/reference/events_api_overview#limitations).\n\nNote any top-level property that is not an object can be\nused to create segments. The `$extra` property records any\nnon-segmentable values that can be referenced later, e.g., HTML templates are\nuseful on a segment but are not used to create a segment.",
"example": {
"Brand": "Kids Book",
"ProductID": 1111,
"ProductName": "Winnie the Pooh"
},
"type": "object"
},
"time": {
"description": "When this event occurred. By default, the time the request was received will be used.\nThe time is truncated to the second. The time must be after the year 2000 and can only\nbe up to 1 year in the future.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"unique_id": {
"description": "A unique identifier for an event. If a unique_id is repeated for the same profile and metric,\nthe request will fail and no events will be processed. If this field is not\npresent, this field will use the time to the second. Using the default, this limits only one\nevent per profile per second.",
"nullable": true,
"type": "string"
},
"value": {
"description": "A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.",
"example": 9.99,
"nullable": true,
"type": "number"
},
"value_currency": {
"description": "The ISO 4217 currency code of the value associated with the event.",
"example": "USD",
"nullable": true,
"type": "string"
}
},
"required": [
"properties",
"metric"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/EventEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"BaseStyle": {
"properties": {
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/BaseStyleProperties"
},
"style_type": {
"enum": [
"base-styles"
],
"type": "string"
},
"styles": {
"$ref": "#/components/schemas/BaseStyleStyles"
}
},
"required": [
"style_type",
"properties",
"styles"
],
"type": "object"
},
"BaseStyleProperties": {
"properties": {
"currency": {
"nullable": true,
"type": "string"
},
"currency_set_on_template": {
"nullable": true,
"type": "boolean"
},
"disable_websafe_fonts": {
"nullable": true,
"type": "boolean"
},
"is_user_draggable": {
"nullable": true,
"type": "boolean"
},
"mobile_optimizations": {
"nullable": true,
"type": "boolean"
},
"tip_tap_enabled": {
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"BaseStyleStyles": {
"properties": {
"background_asset_id": {
"nullable": true,
"type": "string"
},
"background_format": {
"description": "Background format.",
"enum": [
"auto",
"contain",
"cover",
"initial",
"repeat"
],
"nullable": true,
"type": "string"
},
"background_position": {
"description": "Background position.",
"enum": [
"center-bottom",
"center-center",
"center-top",
"left-bottom",
"left-center",
"left-top",
"right-bottom",
"right-center",
"right-top"
],
"nullable": true,
"type": "string"
},
"background_repeat": {
"nullable": true,
"type": "boolean"
},
"background_url": {
"nullable": true,
"type": "string"
},
"border_color": {
"nullable": true,
"type": "string"
},
"border_radius": {
"nullable": true,
"type": "integer"
},
"border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"border_width": {
"nullable": true,
"type": "integer"
},
"content_background_color": {
"nullable": true,
"type": "string"
},
"inner_padding_bottom": {
"nullable": true,
"type": "integer"
},
"inner_padding_left": {
"nullable": true,
"type": "integer"
},
"inner_padding_right": {
"nullable": true,
"type": "integer"
},
"inner_padding_top": {
"nullable": true,
"type": "integer"
},
"margin_top": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"BlockDisplayOptions": {
"properties": {
"content_repeat": {
"$ref": "#/components/schemas/ContentRepeatV0",
"nullable": true
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"visible_check": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"Body": {
"properties": {
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/BodyProperties"
},
"sections": {
"items": {
"$ref": "#/components/schemas/SectionV1"
},
"nullable": true,
"type": "array"
},
"styles": {
"$ref": "#/components/schemas/BodyStyles"
}
},
"required": [
"properties",
"styles"
],
"type": "object"
},
"BodyProperties": {
"properties": {
"css_class": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"BodyStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"width": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"BooleanBranchLinks": {
"properties": {
"next_if_false": {
"nullable": true,
"type": "string"
},
"next_if_true": {
"nullable": true,
"type": "string"
}
},
"required": [
"next_if_true",
"next_if_false"
],
"type": "object"
},
"BooleanFilter": {
"properties": {
"operator": {
"description": "Operators for boolean filters.",
"enum": [
"equals"
],
"type": "string"
},
"type": {
"enum": [
"boolean"
],
"type": "string"
},
"value": {
"type": "boolean"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"BorderStyle": {
"properties": {
"color": {
"nullable": true,
"type": "string"
},
"radius": {
"default": 8,
"example": 8,
"type": "integer"
},
"style": {
"description": "Border pattern enumeration.",
"enum": [
"dashed",
"dotted",
"solid"
],
"nullable": true,
"type": "string"
},
"thickness": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"BounceDateFilter": {
"properties": {
"field": {
"enum": [
"bounce_date"
],
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/IsSetExistenceFilter"
}
]
}
},
"required": [
"field",
"filter"
],
"type": "object"
},
"BulkProfileSuppressionsCreateJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"skipped_count": {
"default": 0,
"description": "The total number of profiles that have been skipped as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Suppress/Unsuppress all profiles in this list",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Suppress/Unsuppress all profiles in this segment",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileSuppressionBulkCreateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"BulkProfileSuppressionsRemoveJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"skipped_count": {
"default": 0,
"description": "The total number of profiles that have been skipped as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Suppress/Unsuppress all profiles in this list",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Suppress/Unsuppress all profiles in this segment",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileSuppressionBulkDeleteJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"BulkRemoveMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"bulk_remove"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"Button": {
"properties": {
"action": {
"oneOf": [
{
"$ref": "#/components/schemas/Close"
},
{
"$ref": "#/components/schemas/NextStep"
},
{
"$ref": "#/components/schemas/OpenForm"
},
{
"$ref": "#/components/schemas/PromotionalSMSSubscription"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/ResendOptInCode"
},
{
"$ref": "#/components/schemas/SubmitOptInCode"
},
{
"$ref": "#/components/schemas/SubscribeViaSMS"
},
{
"$ref": "#/components/schemas/SubscribeViaWhatsApp"
},
{
"$ref": "#/components/schemas/GoToInbox"
},
{
"$ref": "#/components/schemas/SubmitBackInStock"
},
{
"$ref": "#/components/schemas/SkipToSuccess"
},
{
"$ref": "#/components/schemas/IafDeeplinkToScreen"
}
]
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/ButtonProperties"
},
"styles": {
"$ref": "#/components/schemas/ButtonStyles"
},
"type": {
"enum": [
"button"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"ButtonBlockData": {
"properties": {
"content": {
"nullable": true,
"type": "string"
},
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"properties": {
"$ref": "#/components/schemas/ButtonBlockProperties"
},
"styles": {
"$ref": "#/components/schemas/ButtonBlockStyles"
}
},
"required": [
"content",
"properties",
"display_options",
"styles"
],
"type": "object"
},
"ButtonBlockProperties": {
"properties": {
"href": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ButtonBlockStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"border_color": {
"nullable": true,
"type": "string"
},
"border_radius": {
"nullable": true,
"type": "integer"
},
"border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"border_width": {
"nullable": true,
"type": "integer"
},
"color": {
"nullable": true,
"type": "string"
},
"drop_shadow_color": {
"nullable": true,
"type": "string"
},
"font_family": {
"nullable": true,
"type": "string"
},
"font_size": {
"nullable": true,
"type": "integer"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"inner_padding_bottom": {
"nullable": true,
"type": "integer"
},
"inner_padding_left": {
"nullable": true,
"type": "integer"
},
"inner_padding_right": {
"nullable": true,
"type": "integer"
},
"inner_padding_top": {
"nullable": true,
"type": "integer"
},
"letter_spacing": {
"nullable": true,
"type": "integer"
},
"mobile_stretch_content": {
"nullable": true,
"type": "boolean"
},
"stretch": {
"nullable": true,
"type": "boolean"
},
"text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ButtonBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true
},
"type": {
"enum": [
"button"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"ButtonBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/ButtonBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"button"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"ButtonDropShadowStyles": {
"properties": {
"blur": {
"default": 15,
"example": 15,
"type": "integer"
},
"color": {
"default": "#000000",
"example": "#000000",
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
},
"x_offset": {
"default": 0,
"type": "integer"
},
"y_offset": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"ButtonProperties": {
"properties": {
"additional_fields": {
"items": {
"$ref": "#/components/schemas/AdditionalField"
},
"nullable": true,
"type": "array"
},
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"label": {
"type": "string"
}
},
"required": [
"label"
],
"type": "object"
},
"ButtonStyles": {
"properties": {
"alignment": {
"default": "center",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "center",
"type": "string"
},
"background_color": {
"nullable": true,
"type": "string"
},
"border_styles": {
"$ref": "#/components/schemas/BorderStyle"
},
"color": {
"nullable": true,
"type": "string"
},
"drop_shadow": {
"$ref": "#/components/schemas/ButtonDropShadowStyles"
},
"height": {
"default": 50,
"example": 50,
"oneOf": [
{
"type": "integer"
},
{
"enum": [
"auto"
],
"type": "string"
}
]
},
"hover_background_color": {
"nullable": true,
"type": "string"
},
"hover_text_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
},
"text_styles": {
"$ref": "#/components/schemas/TextStyleV0"
},
"width": {
"default": "fill",
"description": "Valid button block widths.",
"enum": [
"fill",
"fit"
],
"example": "fill",
"type": "string"
}
},
"type": "object"
},
"CalendarDateFilter": {
"properties": {
"operator": {
"description": "Operators for calendar date filters.",
"enum": [
"calendar-month"
],
"type": "string"
},
"type": {
"enum": [
"date"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"CampaignCloneQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignCloneQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CampaignCloneQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"new_name": {
"description": "The name for the new cloned campaign",
"example": "My cloned campaign's new name",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The campaign ID to be cloned",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"CampaignCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CampaignCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"audiences": {
"$ref": "#/components/schemas/Audiences",
"description": "The audiences to be included and/or excluded from the campaign"
},
"campaign-messages": {
"description": "The message(s) associated with the campaign",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CampaignMessageCreateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"name": {
"description": "The campaign name",
"example": "My new campaign",
"type": "string"
},
"send_options": {
"description": "Options to use when sending a campaign",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EmailSendOptions"
},
{
"$ref": "#/components/schemas/SMSSendOptions"
},
{
"$ref": "#/components/schemas/PushSendOptions"
}
]
},
"send_strategy": {
"description": "The send strategy the campaign will send with. Defaults to 'Immediate' send strategy.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StaticSendStrategy"
},
{
"$ref": "#/components/schemas/ThrottledSendStrategy"
},
{
"$ref": "#/components/schemas/ImmediateSendStrategy"
},
{
"$ref": "#/components/schemas/SmartSendTimeStrategy"
}
]
},
"tracking_options": {
"description": "The tracking options associated with the campaign",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CampaignsEmailTrackingOptions"
},
{
"$ref": "#/components/schemas/CampaignsSMSTrackingOptions"
}
]
}
},
"required": [
"name",
"audiences",
"campaign-messages"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CampaignEnum": {
"enum": [
"campaign"
],
"type": "string"
},
"CampaignMessageAssignTemplateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignMessageAssignTemplateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CampaignMessageAssignTemplateQueryResourceObject": {
"properties": {
"id": {
"description": "The message ID to be assigned to",
"type": "string"
},
"relationships": {
"properties": {
"template": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The template ID to assign",
"example": "RipRmi",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"template"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"id",
"relationships"
],
"type": "object"
},
"CampaignMessageCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"definition": {
"oneOf": [
{
"$ref": "#/components/schemas/EmailMessageDefinition"
},
{
"$ref": "#/components/schemas/SMSMessageDefinitionCreate"
},
{
"$ref": "#/components/schemas/MobilePushMessageStandardDefinitionCreate"
},
{
"$ref": "#/components/schemas/MobilePushMessageSilentDefinitionCreate"
}
]
}
},
"required": [
"definition"
],
"type": "object"
},
"relationships": {
"properties": {
"image": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The associated image for mobile_push messages",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CampaignMessageEnum": {
"enum": [
"campaign-message"
],
"type": "string"
},
"CampaignMessageImageUpdateQuery": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Campaign Message Image",
"example": "14254",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"required": [
"data"
],
"type": "object"
},
"CampaignMessageIncrement": {
"properties": {
"badge_config": {
"enum": [
"increment_one"
],
"type": "string"
}
},
"required": [
"badge_config"
],
"type": "object"
},
"CampaignMessagePartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignMessagePartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CampaignMessagePartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"definition": {
"description": "The contents and settings of the campaign message",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EmailMessageDefinition"
},
{
"$ref": "#/components/schemas/SMSMessageDefinitionCreate"
},
{
"$ref": "#/components/schemas/MobilePushMessageStandardDefinitionUpdate"
},
{
"$ref": "#/components/schemas/MobilePushMessageSilentDefinitionUpdate"
}
]
}
},
"type": "object"
},
"id": {
"description": "The message ID to be retrieved",
"type": "string"
},
"relationships": {
"properties": {
"image": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The associated image for mobile_push messages",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"CampaignMessageProperty": {
"properties": {
"badge_config": {
"enum": [
"set_property"
],
"type": "string"
},
"set_from_property": {
"type": "string"
}
},
"required": [
"badge_config",
"set_from_property"
],
"type": "object"
},
"CampaignMessageResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created_at": {
"description": "The datetime when the message was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EmailMessageDefinition"
},
{
"$ref": "#/components/schemas/SMSMessageDefinition"
},
{
"$ref": "#/components/schemas/MobilePushMessageStandardDefinition"
},
{
"$ref": "#/components/schemas/MobilePushMessageSilentDefinition"
}
]
},
"send_times": {
"description": "The list of appropriate Send Time Sub-objects associated with the message",
"items": {
"$ref": "#/components/schemas/SendTime"
},
"nullable": true,
"type": "array"
},
"updated_at": {
"description": "The datetime when the message was last updated",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The message ID",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"campaign": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The parent campaign id",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"image": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The associated image id",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"template": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The associated template id",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CampaignMessageStaticCount": {
"properties": {
"badge_config": {
"enum": [
"set_count"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"badge_config",
"value"
],
"type": "object"
},
"CampaignPartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignPartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CampaignPartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"audiences": {
"$ref": "#/components/schemas/AudiencesUpdate",
"description": "The audiences to be included and/or excluded from the campaign",
"nullable": true
},
"name": {
"description": "The campaign name",
"example": "My new campaign",
"nullable": true,
"type": "string"
},
"send_options": {
"description": "Options to use when sending a campaign",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EmailSendOptions"
},
{
"$ref": "#/components/schemas/SMSSendOptions"
},
{
"$ref": "#/components/schemas/PushSendOptions"
}
]
},
"send_strategy": {
"description": "The send strategy the campaign will send with",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StaticSendStrategy"
},
{
"$ref": "#/components/schemas/ThrottledSendStrategy"
},
{
"$ref": "#/components/schemas/ImmediateSendStrategy"
},
{
"$ref": "#/components/schemas/SmartSendTimeStrategy"
}
]
},
"tracking_options": {
"description": "The tracking options associated with the campaign",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CampaignsEmailTrackingOptions"
},
{
"$ref": "#/components/schemas/CampaignsSMSTrackingOptions"
}
]
}
},
"type": "object"
},
"id": {
"description": "The campaign ID to be retrieved",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"CampaignRecipientEstimationEnum": {
"enum": [
"campaign-recipient-estimation"
],
"type": "string"
},
"CampaignRecipientEstimationJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignRecipientEstimationJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CampaignRecipientEstimationJobCreateQueryResourceObject": {
"properties": {
"id": {
"description": "The ID of the campaign to perform recipient estimation",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignRecipientEstimationJobEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CampaignRecipientEstimationJobEnum": {
"enum": [
"campaign-recipient-estimation-job"
],
"type": "string"
},
"CampaignRecipientEstimationJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"status": {
"description": "The status of the recipient estimation job",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"id": {
"description": "The ID of the campaign used for estimating recipients",
"example": "01GMRWDSA0ARTAKE1SFX8JGXAY",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/CampaignRecipientEstimationJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CampaignRecipientEstimationResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"estimated_recipient_count": {
"description": "The estimated number of unique recipients the campaign will send to",
"type": "integer"
}
},
"required": [
"estimated_recipient_count"
],
"type": "object"
},
"id": {
"description": "The ID of the campaign for which to get the estimated number of recipients",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/CampaignRecipientEstimationEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CampaignResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"archived": {
"description": "Whether the campaign has been archived or not",
"type": "boolean"
},
"audiences": {
"$ref": "#/components/schemas/Audiences",
"description": "The audiences to be included and/or excluded from the campaign"
},
"created_at": {
"description": "The datetime when the campaign was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"name": {
"description": "The campaign name",
"type": "string"
},
"scheduled_at": {
"description": "The datetime when the campaign was scheduled for future sending",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"send_options": {
"description": "Options to use when sending a campaign",
"oneOf": [
{
"$ref": "#/components/schemas/EmailSendOptions"
},
{
"$ref": "#/components/schemas/SMSSendOptions"
},
{
"$ref": "#/components/schemas/PushSendOptions"
}
]
},
"send_strategy": {
"description": "The send strategy the campaign will send with",
"oneOf": [
{
"$ref": "#/components/schemas/StaticSendStrategy"
},
{
"$ref": "#/components/schemas/SmartSendTimeStrategy"
},
{
"$ref": "#/components/schemas/ThrottledSendStrategy"
},
{
"$ref": "#/components/schemas/ImmediateSendStrategy"
},
{
"$ref": "#/components/schemas/ABTestSendStrategy"
},
{
"$ref": "#/components/schemas/UnsupportedSendStrategy"
}
]
},
"send_time": {
"description": "The datetime when the campaign will be / was sent or None if not yet scheduled by a send_job.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "The current status of the campaign",
"enum": [
"Adding Recipients",
"Cancelled",
"Cancelled: Account Disabled",
"Cancelled: Billing Limit",
"Cancelled: Internal Error",
"Cancelled: Misconfigured",
"Cancelled: No Recipients",
"Cancelled: Smart Sending",
"Draft",
"Preparing to schedule",
"Preparing to send",
"Queued without Recipients",
"Scheduled",
"Sending",
"Sending Segments",
"Sent",
"Unknown",
"Variations Sent"
],
"type": "string"
},
"tracking_options": {
"description": "The tracking options associated with the campaign",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CampaignsEmailTrackingOptions"
},
{
"$ref": "#/components/schemas/CampaignsSMSTrackingOptions"
}
]
},
"updated_at": {
"description": "The datetime when the campaign was last updated by a user or the system",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"status",
"archived",
"audiences",
"send_options",
"send_strategy",
"created_at",
"updated_at"
],
"type": "object"
},
"id": {
"description": "The campaign ID",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"campaign-messages": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The message(s) associated with the campaign",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CampaignSendJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignSendJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CampaignSendJobCreateQueryResourceObject": {
"properties": {
"id": {
"description": "The ID of the campaign to send",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignSendJobEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CampaignSendJobEnum": {
"enum": [
"campaign-send-job"
],
"type": "string"
},
"CampaignSendJobPartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignSendJobPartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CampaignSendJobPartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"action": {
"description": "The action you would like to take with this send job from among 'cancel' and 'revert'",
"enum": [
"cancel",
"revert"
],
"example": "cancel",
"type": "string"
}
},
"required": [
"action"
],
"type": "object"
},
"id": {
"description": "The ID of the currently sending campaign to cancel or revert",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignSendJobEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"CampaignSendJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"status": {
"description": "The status of the send job",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"id": {
"description": "The ID of the campaign to send",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/CampaignSendJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CampaignTrackingSettingDynamicParam": {
"properties": {
"type": {
"description": "The type of the tracking parameter",
"enum": [
"dynamic"
],
"type": "string"
},
"value": {
"description": "The value of the tracking parameter",
"enum": [
"campaign_id",
"campaign_name",
"campaign_name_id",
"campaign_name_send_day",
"email_subject",
"group_id",
"group_name",
"group_name_id",
"link_alt_text",
"message_type",
"profile_external_id",
"profile_id"
],
"type": "string"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"CampaignTrackingSettingStaticParam": {
"properties": {
"type": {
"description": "The type of the tracking parameter",
"enum": [
"static"
],
"type": "string"
},
"value": {
"description": "The value of the tracking parameter",
"type": "string"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"CampaignValuesReportEnum": {
"enum": [
"campaign-values-report"
],
"type": "string"
},
"CampaignValuesRequestDTO": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignValuesRequestDTOResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CampaignValuesRequestDTOResourceObject": {
"properties": {
"attributes": {
"properties": {
"conversion_metric_id": {
"description": "ID of the metric to be used for conversion statistics",
"example": "RESQ6t",
"type": "string"
},
"filter": {
"description": "API filter string used to filter the query.\nScalar attributes (send_channel, campaign_id, campaign_message_id, campaign_message_name, variation, variation_name, text_message_format): Supported operators: equals, contains-any.\nList attributes (tag_id, tag_name): Supported operators: contains-any, contains-all.\nOnly one filter can be used per attribute.\nOnly AND can be used as a combination operator.\nMax of 100 items per list filter.\nWhen filtering on send_channel, allowed values are email, sms, push-notification, whatsapp.",
"example": "and(equals(campaign_id,\"abc123\"),contains-any(send_channel,[\"email\",\"sms\"]))",
"nullable": true,
"type": "string"
},
"group_by": {
"description": "List of attributes to group the data by.\nAllowed group-bys are campaign_id, campaign_message_id, campaign_message_name, group, group_name, send_channel, tag_id, tag_name, text_message_format, variation, variation_name.\nIf not passed in, the data will be grouped by campaign_id, campaign_message_id, send_channel.\nThe following group by attributes are required: campaign_id, campaign_message_id",
"items": {
"description": "Attributes to represent what is being grouped by / filtered on for Campaigns",
"enum": [
"campaign_id",
"campaign_message_id",
"campaign_message_name",
"group",
"group_name",
"send_channel",
"tag_id",
"tag_name",
"text_message_format",
"variation",
"variation_name"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"statistics": {
"description": "List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]",
"example": [
"opens",
"open_rate"
],
"items": {
"description": "Defined reporting metric",
"enum": [
"average_order_value",
"bounce_rate",
"bounced",
"bounced_or_failed",
"bounced_or_failed_rate",
"click_rate",
"click_to_open_rate",
"clicks",
"clicks_unique",
"conversion_rate",
"conversion_uniques",
"conversion_value",
"conversions",
"delivered",
"delivery_rate",
"failed",
"failed_rate",
"message_segment_count_sum",
"open_rate",
"opens",
"opens_unique",
"recipients",
"revenue_per_recipient",
"spam_complaint_rate",
"spam_complaints",
"text_message_credit_usage_amount",
"text_message_roi",
"text_message_spend",
"unsubscribe_rate",
"unsubscribe_uniques",
"unsubscribes"
],
"type": "string"
},
"type": "array"
},
"timeframe": {
"description": "The time frame to pull data from (Max length: 1 year). See [available time frames](https://developers.klaviyo.com/en/reference/reporting_api_overview#available-time-frames).",
"oneOf": [
{
"$ref": "#/components/schemas/Timeframe"
},
{
"$ref": "#/components/schemas/CustomTimeframe"
}
]
}
},
"required": [
"statistics",
"timeframe",
"conversion_metric_id"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignValuesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CampaignsEmailTrackingOptions": {
"properties": {
"add_tracking_params": {
"description": "Whether the campaign needs custom tracking parameters. If set to False, tracking params will not be used.",
"nullable": true,
"type": "boolean"
},
"custom_tracking_params": {
"description": "A list of custom tracking parameters. If an empty list is given and add_tracking_params is True, uses company defaults.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DynamicTrackingParam"
},
{
"$ref": "#/components/schemas/StaticTrackingParam"
}
]
},
"nullable": true,
"type": "array"
},
"is_tracking_clicks": {
"description": "Whether the campaign is tracking click events. If not specified, uses company defaults.",
"nullable": true,
"type": "boolean"
},
"is_tracking_opens": {
"description": "Whether the campaign is tracking open events. If not specified, uses company defaults.",
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"CampaignsSMSTrackingOptions": {
"properties": {
"add_tracking_params": {
"description": "Whether the campaign needs custom tracking parameters. If set to False, tracking params will not be used.",
"nullable": true,
"type": "boolean"
},
"custom_tracking_params": {
"description": "A list of custom tracking parameters. If an empty list is given and add_tracking_params is True, uses company defaults.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DynamicTrackingParam"
},
{
"$ref": "#/components/schemas/StaticTrackingParam"
}
]
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"CarrierDeactivationMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"carrier_deactivation"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"CartContent": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/CartContentProperties"
},
"type": {
"enum": [
"cart_content"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"CartContentProperties": {
"properties": {
"items": {
"$ref": "#/components/schemas/CartItemCountProperties",
"nullable": true
},
"product": {
"$ref": "#/components/schemas/CartProductProperties",
"nullable": true
},
"value": {
"$ref": "#/components/schemas/CartValueProperties",
"nullable": true
}
},
"type": "object"
},
"CartItemCount": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/CartItemCountProperties"
},
"type": {
"enum": [
"cart_item_count"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"CartItemCountProperties": {
"properties": {
"comparison": {
"description": "Number comparison enumeration.",
"enum": [
"equals",
"greater_than",
"less_than"
],
"nullable": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"CartProduct": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/CartProductProperties"
},
"type": {
"enum": [
"cart_product"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"CartProductProperties": {
"properties": {
"type": {
"description": "Product descriptor enumeration.",
"enum": [
"brand",
"categories",
"id",
"name"
],
"nullable": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"CartValue": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/CartValueProperties"
},
"type": {
"enum": [
"cart_value"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"CartValueProperties": {
"properties": {
"comparison": {
"description": "Number comparison enumeration.",
"enum": [
"equals",
"greater_than",
"less_than"
],
"nullable": true,
"type": "string"
},
"value": {
"nullable": true,
"type": "number"
}
},
"type": "object"
},
"CatalogCategoryBulkCreateJobEnum": {
"enum": [
"catalog-category-bulk-create-job"
],
"type": "string"
},
"CatalogCategoryBulkDeleteJobEnum": {
"enum": [
"catalog-category-bulk-delete-job"
],
"type": "string"
},
"CatalogCategoryBulkUpdateJobEnum": {
"enum": [
"catalog-category-bulk-update-job"
],
"type": "string"
},
"CatalogCategoryCreateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogCategoryCreateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogCategoryCreateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"categories": {
"description": "Array of catalog categories to create.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogCategoryCreateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"categories"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryBulkCreateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogCategoryCreateJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the created catalog categories.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryBulkCreateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogCategoryCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogCategoryCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogCategoryCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"catalog_type": {
"default": "$default",
"description": "The type of catalog. Currently only \"$default\" is supported.",
"example": "$default",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "The ID of the catalog category in an external system.",
"example": "SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"integration_type": {
"default": "$custom",
"description": "The integration type. Currently only \"$custom\" is supported.",
"enum": [
"$custom"
],
"example": "$custom",
"nullable": true,
"type": "string"
},
"name": {
"description": "The name of the catalog category.",
"example": "Sample Data Category Apparel",
"type": "string"
}
},
"required": [
"external_id",
"name"
],
"type": "object"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A list of catalog item IDs that are in the given category.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogCategoryDeleteJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogCategoryDeleteJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogCategoryDeleteJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"categories": {
"description": "Array of catalog categories to delete.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogCategoryDeleteQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"categories"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryBulkDeleteJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogCategoryDeleteJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the deleted catalog categories.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryBulkDeleteJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogCategoryDeleteQueryResourceObject": {
"properties": {
"id": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CatalogCategoryEnum": {
"enum": [
"catalog-category"
],
"type": "string"
},
"CatalogCategoryItemOp": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A list of catalog item IDs that are in the given category.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogCategoryResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"external_id": {
"description": "The ID of the catalog category in an external system.",
"example": "SAMPLE-DATA-CATEGORY-APPAREL",
"nullable": true,
"type": "string"
},
"name": {
"description": "The name of the catalog category.",
"example": "Sample Data Category Apparel",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the catalog category was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogCategoryUpdateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogCategoryUpdateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogCategoryUpdateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"categories": {
"description": "Array of catalog categories to update.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogCategoryUpdateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"categories"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryBulkUpdateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogCategoryUpdateJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the updated catalog categories.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryBulkUpdateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogCategoryUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogCategoryUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogCategoryUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"name": {
"description": "The name of the catalog category.",
"example": "Sample Data Category Apparel",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A list of catalog item IDs that are in the given category.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"CatalogItemBulkCreateJobEnum": {
"enum": [
"catalog-item-bulk-create-job"
],
"type": "string"
},
"CatalogItemBulkDeleteJobEnum": {
"enum": [
"catalog-item-bulk-delete-job"
],
"type": "string"
},
"CatalogItemBulkUpdateJobEnum": {
"enum": [
"catalog-item-bulk-update-job"
],
"type": "string"
},
"CatalogItemCategoryOp": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A list of catalog category IDs representing the categories the item is in",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogItemCreateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogItemCreateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogItemCreateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"items": {
"description": "Array of catalog items to create.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogItemCreateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"items"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemBulkCreateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogItemCreateJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the created catalog items.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemBulkCreateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogItemCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogItemCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogItemCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"catalog_type": {
"default": "$default",
"description": "The type of catalog. Currently only \"$default\" is supported.",
"example": "$default",
"nullable": true,
"type": "string"
},
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.",
"example": {
"Top Pick": true
},
"nullable": true,
"type": "object"
},
"description": {
"description": "A description of the catalog item.",
"example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"type": "string"
},
"external_id": {
"description": "The ID of the catalog item in an external system.",
"example": "SAMPLE-DATA-ITEM-1",
"type": "string"
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item.",
"example": "https://via.placeholder.com/300",
"nullable": true,
"type": "string"
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item.",
"example": [
"https://via.placeholder.com/150"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"integration_type": {
"default": "$custom",
"description": "The integration type. Currently only \"$custom\" is supported.",
"enum": [
"$custom"
],
"example": "$custom",
"nullable": true,
"type": "string"
},
"price": {
"description": "This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).",
"example": 42,
"nullable": true,
"type": "number"
},
"published": {
"default": true,
"description": "Boolean value indicating whether the catalog item is published.",
"example": true,
"nullable": true,
"type": "boolean"
},
"title": {
"description": "The title of the catalog item.",
"example": "Ocean Blue Shirt (Sample)",
"type": "string"
},
"url": {
"description": "URL pointing to the location of the catalog item on your website.",
"example": "https://via.placeholder.com/150",
"type": "string"
}
},
"required": [
"external_id",
"title",
"description",
"url"
],
"type": "object"
},
"relationships": {
"properties": {
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A list of catalog category IDs representing the categories the item is in",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogItemDeleteJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogItemDeleteJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogItemDeleteJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"items": {
"description": "Array of catalog items to delete.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogItemDeleteQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"items"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemBulkDeleteJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogItemDeleteJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the deleted catalog items.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemBulkDeleteJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogItemDeleteQueryResourceObject": {
"properties": {
"id": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CatalogItemEnum": {
"enum": [
"catalog-item"
],
"type": "string"
},
"CatalogItemResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the catalog item was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.",
"example": {
"Top Pick": true
},
"nullable": true,
"type": "object"
},
"description": {
"description": "A description of the catalog item.",
"example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "The ID of the catalog item in an external system.",
"example": "SAMPLE-DATA-ITEM-1",
"nullable": true,
"type": "string"
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item.",
"example": "https://via.placeholder.com/300",
"nullable": true,
"type": "string"
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item.",
"example": [
"https://via.placeholder.com/150"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"price": {
"description": "This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).",
"example": 42,
"nullable": true,
"type": "number"
},
"published": {
"description": "Boolean value indicating whether the catalog item is published.",
"example": true,
"nullable": true,
"type": "boolean"
},
"title": {
"description": "The title of the catalog item.",
"example": "Ocean Blue Shirt (Sample)",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the catalog item was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"url": {
"description": "URL pointing to the location of the catalog item on your website.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"variants": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogItemUpdateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogItemUpdateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogItemUpdateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"items": {
"description": "Array of catalog items to update.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogItemUpdateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"items"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemBulkUpdateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogItemUpdateJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the updated catalog items.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemBulkUpdateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogItemUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogItemUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogItemUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.",
"example": {
"Top Pick": true
},
"nullable": true,
"type": "object"
},
"description": {
"description": "A description of the catalog item.",
"example": "A description of the catalog item.",
"nullable": true,
"type": "string"
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item.",
"example": "https://via.placeholder.com/300",
"nullable": true,
"type": "string"
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item.",
"example": [
"https://via.placeholder.com/150"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"price": {
"description": "This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).",
"example": 42,
"nullable": true,
"type": "number"
},
"published": {
"description": "Boolean value indicating whether the catalog item is published.",
"example": true,
"nullable": true,
"type": "boolean"
},
"title": {
"description": "The title of the catalog item.",
"example": "Ocean Blue Shirt (Sample)",
"nullable": true,
"type": "string"
},
"url": {
"description": "URL pointing to the location of the catalog item on your website.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"relationships": {
"properties": {
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A list of catalog category IDs representing the categories the item is in",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"CatalogVariantBulkCreateJobEnum": {
"enum": [
"catalog-variant-bulk-create-job"
],
"type": "string"
},
"CatalogVariantBulkDeleteJobEnum": {
"enum": [
"catalog-variant-bulk-delete-job"
],
"type": "string"
},
"CatalogVariantBulkUpdateJobEnum": {
"enum": [
"catalog-variant-bulk-update-job"
],
"type": "string"
},
"CatalogVariantCreateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogVariantCreateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogVariantCreateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"variants": {
"description": "Array of catalog variants to create.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogVariantCreateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"variants"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantBulkCreateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogVariantCreateJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"variants": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the created catalog variants.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantBulkCreateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogVariantCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogVariantCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogVariantCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"catalog_type": {
"default": "$default",
"description": "The type of catalog. Currently only \"$default\" is supported.",
"example": "$default",
"nullable": true,
"type": "string"
},
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
"example": {
"Top Pick": true
},
"nullable": true,
"type": "object"
},
"description": {
"description": "A description of the catalog item variant.",
"example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"type": "string"
},
"external_id": {
"description": "The ID of the catalog item variant in an external system.",
"example": "SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item variant.",
"example": "https://via.placeholder.com/300",
"nullable": true,
"type": "string"
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item variant.",
"example": [
"https://via.placeholder.com/150"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"integration_type": {
"default": "$custom",
"description": "The integration type. Currently only \"$custom\" is supported.",
"enum": [
"$custom"
],
"example": "$custom",
"nullable": true,
"type": "string"
},
"inventory_policy": {
"default": 0,
"description": "This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.",
"enum": [
0,
1,
2
],
"example": 2,
"nullable": true,
"type": "integer"
},
"inventory_quantity": {
"description": "The quantity of the catalog item variant currently in stock.",
"example": 25,
"type": "number"
},
"price": {
"description": "This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).",
"example": 42,
"type": "number"
},
"published": {
"default": true,
"description": "Boolean value indicating whether the catalog item variant is published.",
"example": true,
"nullable": true,
"type": "boolean"
},
"sku": {
"description": "The SKU of the catalog item variant.",
"example": "OBS-MD",
"type": "string"
},
"title": {
"description": "The title of the catalog item variant.",
"example": "Ocean Blue Shirt (Sample) Variant Medium",
"type": "string"
},
"url": {
"description": "URL pointing to the location of the catalog item variant on your website.",
"example": "https://via.placeholder.com/150",
"type": "string"
}
},
"required": [
"external_id",
"title",
"description",
"sku",
"inventory_quantity",
"price",
"url"
],
"type": "object"
},
"relationships": {
"properties": {
"item": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The original catalog item ID for which this is a variant.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"item"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"attributes",
"relationships"
],
"type": "object"
},
"CatalogVariantDeleteJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogVariantDeleteJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogVariantDeleteJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"variants": {
"description": "Array of catalog variants to delete.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogVariantDeleteQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"variants"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantBulkDeleteJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogVariantDeleteJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"variants": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the deleted catalog variants.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantBulkDeleteJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogVariantDeleteQueryResourceObject": {
"properties": {
"id": {
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"CatalogVariantEnum": {
"enum": [
"catalog-variant"
],
"type": "string"
},
"CatalogVariantResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the catalog item variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
"example": {
"Top Pick": true
},
"nullable": true,
"type": "object"
},
"description": {
"description": "A description of the catalog item variant.",
"example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "The ID of the catalog item variant in an external system.",
"example": "SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"nullable": true,
"type": "string"
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item variant.",
"example": "https://via.placeholder.com/300",
"nullable": true,
"type": "string"
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item variant.",
"example": [
"https://via.placeholder.com/150"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"inventory_policy": {
"description": "This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.",
"enum": [
0,
1,
2
],
"example": 2,
"nullable": true,
"type": "integer"
},
"inventory_quantity": {
"description": "The quantity of the catalog item variant currently in stock.",
"example": 25,
"nullable": true,
"type": "number"
},
"price": {
"description": "This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).",
"example": 42,
"nullable": true,
"type": "number"
},
"published": {
"description": "Boolean value indicating whether the catalog item variant is published.",
"example": true,
"nullable": true,
"type": "boolean"
},
"sku": {
"description": "The SKU of the catalog item variant.",
"example": "OBS-MD",
"nullable": true,
"type": "string"
},
"title": {
"description": "The title of the catalog item variant.",
"example": "Ocean Blue Shirt (Sample) Variant Medium",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"url": {
"description": "URL pointing to the location of the catalog item variant on your website.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"item": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogVariantUpdateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogVariantUpdateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogVariantUpdateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"variants": {
"description": "Array of catalog variants to update.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogVariantUpdateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"variants"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantBulkUpdateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CatalogVariantUpdateJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"variants": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the updated catalog variants.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantBulkUpdateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CatalogVariantUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogVariantUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CatalogVariantUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
"example": {
"Top Pick": true
},
"nullable": true,
"type": "object"
},
"description": {
"description": "A description of the catalog item variant.",
"example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"nullable": true,
"type": "string"
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item variant.",
"example": "https://via.placeholder.com/300",
"nullable": true,
"type": "string"
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item variant.",
"example": [
"https://via.placeholder.com/150"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"inventory_policy": {
"description": "This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.",
"enum": [
0,
1,
2
],
"example": 2,
"nullable": true,
"type": "integer"
},
"inventory_quantity": {
"description": "The quantity of the catalog item variant currently in stock.",
"example": 25,
"nullable": true,
"type": "number"
},
"price": {
"description": "This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).",
"example": 42,
"nullable": true,
"type": "number"
},
"published": {
"description": "Boolean value indicating whether the catalog item variant is published.",
"example": true,
"nullable": true,
"type": "boolean"
},
"sku": {
"description": "The SKU of the catalog item variant.",
"example": "OBS-MD",
"nullable": true,
"type": "string"
},
"title": {
"description": "The title of the catalog item variant.",
"example": "Ocean Blue Shirt (Sample) Variant Medium",
"nullable": true,
"type": "string"
},
"url": {
"description": "URL pointing to the location of the catalog item variant on your website.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"Channel": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/ChannelProperties"
},
"type": {
"enum": [
"channel"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"ChannelProperties": {
"properties": {
"channel": {
"description": "Channel type enumeration.",
"enum": [
"email",
"sms"
],
"type": "string"
}
},
"required": [
"channel"
],
"type": "object"
},
"ChannelSettings": {
"properties": {
"sms": {
"$ref": "#/components/schemas/PhoneNumberConsentChannelSettings"
},
"whatsapp": {
"$ref": "#/components/schemas/PhoneNumberConsentChannelSettings"
}
},
"type": "object"
},
"Checkboxes": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/CheckboxesProperties"
},
"styles": {
"$ref": "#/components/schemas/CheckboxesStyles"
},
"type": {
"enum": [
"checkboxes"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"CheckboxesProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"options": {
"items": {
"$ref": "#/components/schemas/PropertyOption"
},
"type": "array"
},
"placeholder": {
"nullable": true,
"type": "string"
},
"property_name": {
"type": "string"
},
"required": {
"default": false,
"nullable": true,
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
}
},
"required": [
"property_name",
"options"
],
"type": "object"
},
"CheckboxesStyles": {
"properties": {
"alignment": {
"default": "left",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "left",
"type": "string"
},
"arrangement": {
"default": "vertical",
"description": "Arrangement enumeration.",
"enum": [
"horizontal",
"vertical"
],
"example": "vertical",
"type": "string"
},
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"CheckoutMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"checkout"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"ClientBISSubscriptionCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ClientBISSubscriptionCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ClientBISSubscriptionCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"channels": {
"description": "The channel(s) through which the profile would like to receive the back in stock notification. This can be leveraged within a back in stock flow to notify the subscriber through their preferred channel(s).",
"example": [
"EMAIL",
"SMS"
],
"items": {
"description": "The different channel types that a profile could subscribe to BIS notifications for",
"enum": [
"EMAIL",
"PUSH",
"SMS",
"WHATSAPP"
],
"type": "string"
},
"type": "array"
},
"profile": {
"example": {
"data": {
"attributes": {
"email": "sarah.mason@klaviyo-demo.com",
"external_id": "63f64a2b-c6bf-40c7-b81f-bed08162edbe",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"phone_number": "+15005550006"
},
"type": "profile"
}
},
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileIdentifierDTOResourceObject"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"channels",
"profile"
],
"type": "object"
},
"relationships": {
"properties": {
"variant": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The catalog variant ID for which the profile is subscribing to back in stock notifications. This ID is made up of the integration type, catalog ID, and and the external ID of the variant like so: `integrationType:::catalogId:::externalId`. If the integration you are using is not set up for multi-catalog storage, the 'catalogId' will be `$default`. For Shopify `$shopify:::$default:::33001893429341`",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"variant"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/BackInStockSubscriptionEnum"
}
},
"required": [
"type",
"attributes",
"relationships"
],
"type": "object"
},
"ClientReviewResponseDTOObjectResource": {
"properties": {
"attributes": {
"properties": {
"author": {
"description": "The author of this review",
"example": "John D",
"nullable": true,
"type": "string"
},
"content": {
"description": "The content of this review",
"example": "Great product! I love the smell. I will be buying again.",
"nullable": true,
"type": "string"
},
"created": {
"description": "The datetime when this review was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"images": {
"description": "The list of images submitted with this review (represented as a list of urls). If there are no images, this field will be an empty list.",
"example": [
"https://example.com/image1.jpg",
"https://example.com/image2.jpg"
],
"items": {
"type": "string"
},
"type": "array"
},
"product": {
"$ref": "#/components/schemas/ReviewProductDTO",
"description": "The product associated with this review",
"nullable": true
},
"public_reply": {
"$ref": "#/components/schemas/ReviewPublicReply",
"description": "The public reply to this review (if one exists)",
"nullable": true
},
"rating": {
"description": "The rating of this review on a scale from 1-5. If the review type is \"question\", this field will be null.",
"example": 2,
"nullable": true,
"type": "integer"
},
"review_type": {
"description": "The type of this review \u2014 either a review, question, or rating",
"enum": [
"question",
"rating",
"review",
"store"
],
"example": "review",
"type": "string"
},
"smart_quote": {
"description": "A quote from this review that summarizes the content",
"example": "I love the smell",
"nullable": true,
"type": "string"
},
"status": {
"description": "The status of this review",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReviewStatusRejected"
},
{
"$ref": "#/components/schemas/ReviewStatusFeatured"
},
{
"$ref": "#/components/schemas/ReviewStatusPublished"
},
{
"$ref": "#/components/schemas/ReviewStatusUnpublished"
},
{
"$ref": "#/components/schemas/ReviewStatusPending"
}
]
},
"title": {
"description": "The title of this review",
"example": "Smells great, would recommend",
"nullable": true,
"type": "string"
},
"updated": {
"description": "The datetime when this review was updated",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"verified": {
"description": "The verification status of this review (aka whether or not we have confirmation that the customer bought the product)",
"example": true,
"type": "boolean"
}
},
"required": [
"verified",
"review_type",
"created",
"updated",
"images"
],
"type": "object"
},
"id": {
"description": "The ID of the review",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/ReviewEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"Close": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/CloseProperties",
"nullable": true
},
"submit": {
"type": "boolean"
},
"type": {
"enum": [
"close"
],
"type": "string"
}
},
"required": [
"submit",
"type"
],
"type": "object"
},
"CloseButtonStyle": {
"properties": {
"background_color": {
"default": "rgba(180, 187, 195, 0.65)",
"example": "rgba(180, 187, 195, 0.65)",
"type": "string"
},
"color": {
"default": "#FFFFFF",
"example": "#FFFFFF",
"type": "string"
},
"margin": {
"$ref": "#/components/schemas/Margin"
},
"outline_color": {
"default": "#FFFFFF",
"example": "#FFFFFF",
"type": "string"
},
"size": {
"default": 20,
"example": 20,
"type": "integer"
},
"stroke": {
"default": 2,
"example": 2,
"type": "number"
}
},
"type": "object"
},
"CloseProperties": {
"properties": {
"list_id": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"CodeAction": {
"properties": {
"data": {
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"code"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"CollectionLinks": {
"properties": {
"next": {
"format": "uri",
"type": "string"
},
"prev": {
"format": "uri",
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"required": [
"self"
],
"type": "object"
},
"ColumnData": {
"maxProperties": 0,
"type": "object"
},
"ColumnStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"background_image": {
"$ref": "#/components/schemas/BackgroundImage",
"nullable": true
}
},
"type": "object"
},
"ColumnV0": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"rows": {
"items": {
"$ref": "#/components/schemas/RowV0"
},
"type": "array"
},
"styles": {
"$ref": "#/components/schemas/ColumnStyles",
"nullable": true
}
},
"type": "object"
},
"ColumnV1": {
"properties": {
"blocks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ButtonBlockV1"
},
{
"$ref": "#/components/schemas/CouponBlockV1"
},
{
"$ref": "#/components/schemas/DropShadowBlockV1"
},
{
"$ref": "#/components/schemas/HeaderBlockV1"
},
{
"$ref": "#/components/schemas/HorizontalRuleBlockV1"
},
{
"$ref": "#/components/schemas/HTMLBlockV1"
},
{
"$ref": "#/components/schemas/ImageBlockV1"
},
{
"$ref": "#/components/schemas/ProductBlockV1"
},
{
"$ref": "#/components/schemas/ReviewBlockV1"
},
{
"$ref": "#/components/schemas/SocialBlockV1"
},
{
"$ref": "#/components/schemas/SpacerBlockV1"
},
{
"$ref": "#/components/schemas/SplitBlockV1"
},
{
"$ref": "#/components/schemas/TableBlockV1"
},
{
"$ref": "#/components/schemas/TextBlockV1"
},
{
"$ref": "#/components/schemas/VideoBlockV1"
}
]
},
"nullable": true,
"type": "array"
},
"data": {
"$ref": "#/components/schemas/ColumnData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ConditionGroup": {
"properties": {
"conditions": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/SegmentsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
},
{
"$ref": "#/components/schemas/SegmentsProfileMetricFunnelCondition"
}
]
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"ConditionalBranchAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/ConditionalBranchActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/BooleanBranchLinks",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"conditional-split"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ConditionalBranchActionData": {
"properties": {
"profile_filter": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
}
]
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
}
},
"required": [
"profile_filter"
],
"type": "object"
},
"ConstantContactIntegrationFilter": {
"properties": {
"operator": {
"enum": [
"in"
],
"type": "string"
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"value": {
"items": {
"enum": [
"constant_contact"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ConstantContactIntegrationMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/ConstantContactIntegrationFilter"
},
"method": {
"enum": [
"integration"
],
"type": "string"
}
},
"required": [
"field",
"method",
"filter"
],
"type": "object"
},
"ContactInformation": {
"properties": {
"default_sender_email": {
"description": "This field is used to auto-populate the default sender email address on flow and campaign emails.",
"example": "contact@klaviyo-demo.com",
"type": "string"
},
"default_sender_name": {
"description": "This field is used to auto-populate the default sender name on flow and campaign emails.",
"example": "Klaviyo Demo",
"type": "string"
},
"organization_name": {
"example": "Klaviyo Demo",
"type": "string"
},
"street_address": {
"$ref": "#/components/schemas/StreetAddress",
"description": "Street address for your organization."
},
"website_url": {
"example": "https://www.klaviyo.com",
"nullable": true,
"type": "string"
}
},
"required": [
"default_sender_name",
"default_sender_email",
"organization_name",
"street_address"
],
"type": "object"
},
"ContentExperimentAction": {
"properties": {
"data": {
"properties": {
"current_experiment": {
"nullable": true,
"properties": {
"allocations": {
"nullable": true,
"type": "object"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"started": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"variations": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/SendPushNotificationAction"
},
{
"$ref": "#/components/schemas/SendWhatsAppAction"
}
]
},
"type": "array"
},
"winner_metric": {
"description": "The metric to use to determine the winner of the content experiment\n action.",
"enum": [
"click-rate",
"open-rate"
],
"nullable": true,
"type": "string"
}
},
"required": [
"variations"
],
"type": "object"
},
"experiment_status": {
"description": "Not allowed on create.",
"enum": [
"completed",
"draft",
"live"
],
"nullable": true,
"type": "string"
},
"main_action": {
"oneOf": [
{
"$ref": "#/components/schemas/SendPushNotificationAction"
},
{
"$ref": "#/components/schemas/SendWhatsAppAction"
}
]
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"required": [
"main_action"
],
"type": "object"
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"content-experiment"
],
"type": "string"
}
},
"required": [
"type",
"data"
],
"type": "object"
},
"ContentRepeatV0": {
"properties": {
"item_alias": {
"type": "string"
},
"repeat_for": {
"type": "string"
}
},
"required": [
"repeat_for",
"item_alias"
],
"type": "object"
},
"ContentRepeatV1": {
"properties": {
"item_alias": {
"type": "string"
},
"repeat_for": {
"type": "string"
}
},
"required": [
"repeat_for",
"item_alias"
],
"type": "object"
},
"ConversationEnum": {
"enum": [
"conversation"
],
"type": "string"
},
"ConversationMessageCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ConversationMessageCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ConversationMessageCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"body": {
"type": "string"
}
},
"required": [
"body"
],
"type": "object"
},
"relationships": {
"properties": {
"conversation": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Related Conversation",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ConversationEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"conversation"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ConversationMessageEnum"
}
},
"required": [
"type",
"attributes",
"relationships"
],
"type": "object"
},
"ConversationMessageEnum": {
"enum": [
"conversation-message"
],
"type": "string"
},
"ConversationResponseObjectResource": {
"properties": {
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"profile": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ConversationEnum"
}
},
"required": [
"type",
"id",
"links"
],
"type": "object"
},
"CountdownDelayAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/CountdownDelayActionData"
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"countdown-delay"
],
"type": "string"
}
},
"required": [
"type",
"data"
],
"type": "object"
},
"CountdownDelayActionData": {
"properties": {
"delay_until_time": {
"format": "time",
"nullable": true,
"type": "string"
},
"delay_until_weekdays": {
"items": {
"description": "Days of the week.",
"enum": [
"friday",
"monday",
"saturday",
"sunday",
"thursday",
"tuesday",
"wednesday"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"timezone": {
"default": "profile",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC",
"profile"
],
"example": "profile",
"type": "string"
},
"unit": {
"default": "days",
"description": "Defined as FlowDateTrigger attributes in app.",
"enum": [
"days",
"months",
"weeks"
],
"example": "days",
"type": "string"
},
"value": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"CountdownTimer": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/CountdownTimerProperties"
},
"styles": {
"$ref": "#/components/schemas/CountdownTimerStyles"
},
"type": {
"enum": [
"countdown_timer"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"CountdownTimerProperties": {
"properties": {
"animation": {
"default": "heartbeat",
"description": "Options for timer completion animations.",
"enum": [
"flash",
"heartbeat",
"pulse"
],
"example": "heartbeat",
"nullable": true,
"type": "string"
},
"classname": {
"nullable": true,
"type": "string"
},
"clock_face": {
"default": "simple",
"description": "Options for displaying a timer.",
"enum": [
"flip",
"simple"
],
"example": "simple",
"type": "string"
},
"configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/FixedTimerConfiguration"
},
{
"$ref": "#/components/schemas/VariableTimerConfiguration"
}
]
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"configuration"
],
"type": "object"
},
"CountdownTimerStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"card_color": {
"default": "rgba(100,100,100, 1.0)",
"example": "rgba(100,100,100, 1.0)",
"type": "string"
},
"label_font_size": {
"default": 12,
"example": 12,
"type": "integer"
},
"label_font_weight": {
"default": 400,
"description": "Font weight enumeration.",
"enum": [
100,
200,
300,
400,
500,
600,
700,
800,
900
],
"example": 400,
"type": "integer"
},
"padding": {
"$ref": "#/components/schemas/Padding"
},
"text_styles": {
"$ref": "#/components/schemas/TextStyleV0"
}
},
"type": "object"
},
"Coupon": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/CouponProperties"
},
"styles": {
"$ref": "#/components/schemas/CouponStyles"
},
"type": {
"enum": [
"coupon"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"CouponBlockData": {
"properties": {
"content": {
"type": "string"
},
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"properties": {
"$ref": "#/components/schemas/CouponBlockProperties"
},
"styles": {
"$ref": "#/components/schemas/CouponBlockStyles"
}
},
"required": [
"content",
"properties",
"display_options",
"styles"
],
"type": "object"
},
"CouponBlockProperties": {
"properties": {
"coupon": {
"nullable": true,
"type": "string"
},
"coupon_id": {
"nullable": true,
"type": "string"
},
"header_enabled": {
"nullable": true,
"type": "boolean"
},
"href": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"CouponBlockStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"border_color": {
"nullable": true,
"type": "string"
},
"border_radius": {
"nullable": true,
"type": "integer"
},
"border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"border_width": {
"nullable": true,
"type": "integer"
},
"color": {
"nullable": true,
"type": "string"
},
"font_family": {
"nullable": true,
"type": "string"
},
"font_size": {
"nullable": true,
"type": "integer"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"header_font_family": {
"nullable": true,
"type": "string"
},
"header_font_size": {
"nullable": true,
"type": "integer"
},
"header_padding_bottom": {
"nullable": true,
"type": "integer"
},
"header_padding_left": {
"nullable": true,
"type": "integer"
},
"header_padding_right": {
"nullable": true,
"type": "integer"
},
"header_padding_top": {
"nullable": true,
"type": "integer"
},
"inner_padding_bottom": {
"nullable": true,
"type": "integer"
},
"inner_padding_left": {
"nullable": true,
"type": "integer"
},
"inner_padding_right": {
"nullable": true,
"type": "integer"
},
"inner_padding_top": {
"nullable": true,
"type": "integer"
},
"letter_spacing": {
"nullable": true,
"type": "integer"
},
"mobile_stretch_content": {
"nullable": true,
"type": "boolean"
},
"stretch": {
"nullable": true,
"type": "boolean"
},
"text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"CouponBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"type": {
"enum": [
"coupon"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"CouponBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/CouponBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"coupon"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"CouponCodeBulkCreateJobEnum": {
"enum": [
"coupon-code-bulk-create-job"
],
"type": "string"
},
"CouponCodeCreateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CouponCodeCreateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CouponCodeCreateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"coupon-codes": {
"description": "Array of coupon codes to create.",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CouponCodeCreateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"coupon-codes"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CouponCodeBulkCreateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CouponCodeCreateJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"coupon-codes": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the created coupon codes.",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CouponCodeEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CouponCodeBulkCreateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CouponCodeCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CouponCodeCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CouponCodeCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"expires_at": {
"description": "The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"unique_code": {
"description": "This is a unique string that will be or is assigned to each customer/profile and is associated with a coupon.",
"example": "ASD325FHK324UJDOI2M3JNES99",
"type": "string"
}
},
"required": [
"unique_code"
],
"type": "object"
},
"relationships": {
"properties": {
"coupon": {
"properties": {
"data": {
"properties": {
"id": {
"example": "10OFF",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CouponEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"coupon"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CouponCodeEnum"
}
},
"required": [
"type",
"attributes",
"relationships"
],
"type": "object"
},
"CouponCodeEnum": {
"enum": [
"coupon-code"
],
"type": "string"
},
"CouponCodeResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"expires_at": {
"description": "The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "The current status of the coupon code.",
"enum": [
"ASSIGNED_TO_PROFILE",
"DELETING",
"PROCESSING",
"UNASSIGNED",
"USED",
"VERSION_NOT_ACTIVE"
],
"example": "UNASSIGNED",
"nullable": true,
"type": "string"
},
"unique_code": {
"description": "This is a unique string that will be or is assigned to each customer/profile and is associated with a coupon.",
"example": "ASD325FHK324UJDOI2M3JNES99",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"coupon": {
"properties": {
"data": {
"properties": {
"id": {
"example": "10OFF",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CouponEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profile": {
"properties": {
"data": {
"properties": {
"id": {
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CouponCodeEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CouponCodeUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CouponCodeUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CouponCodeUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"expires_at": {
"description": "The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "The API status of our coupon codes.",
"enum": [
"ASSIGNED_TO_PROFILE",
"DELETING",
"PROCESSING",
"UNASSIGNED",
"USED",
"VERSION_NOT_ACTIVE"
],
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CouponCodeEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"CouponCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CouponCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CouponCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"description": {
"description": "A description of the coupon.",
"example": "10% off for purchases over $50",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "This is the id that is stored in an integration such as Shopify or Magento.",
"example": "10OFF",
"type": "string"
},
"monitor_configuration": {
"description": "The monitor configuration for the coupon.",
"example": {
"low_balance_threshold": 500
},
"nullable": true,
"type": "object"
}
},
"required": [
"external_id"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CouponEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CouponEnum": {
"enum": [
"coupon"
],
"type": "string"
},
"CouponProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"coupon": {
"oneOf": [
{
"$ref": "#/components/schemas/UniqueCouponConfig"
},
{
"$ref": "#/components/schemas/StaticCouponConfig"
}
]
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"success_message": {
"nullable": true,
"type": "string"
}
},
"required": [
"coupon"
],
"type": "object"
},
"CouponResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"description": {
"description": "A description of the coupon.",
"example": "10% off for purchases over $50",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "This is the id that is stored in an integration such as Shopify or Magento.",
"example": "10OFF",
"type": "string"
},
"monitor_configuration": {
"description": "The monitor configuration for the coupon.",
"example": {
"low_balance_threshold": 500
},
"nullable": true,
"type": "object"
}
},
"required": [
"external_id"
],
"type": "object"
},
"id": {
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"example": "10OFF",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/CouponEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CouponStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"border_styles": {
"$ref": "#/components/schemas/BorderStyle",
"nullable": true
},
"coupon_background_color": {
"default": "#EEEEEE",
"example": "#EEEEEE",
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
},
"text_styles": {
"$ref": "#/components/schemas/TextStyleV0"
}
},
"type": "object"
},
"CouponUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CouponUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CouponUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"description": {
"description": "A description of the coupon.",
"example": "10% off for purchases over $50",
"nullable": true,
"type": "string"
},
"monitor_configuration": {
"description": "The monitor configuration for the coupon.",
"example": {
"low_balance_threshold": 500
},
"nullable": true,
"type": "object"
}
},
"type": "object"
},
"id": {
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"example": "10OFF",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CouponEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"CustomCss": {
"properties": {
"css": {
"default": "",
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
"CustomJavascript": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/TriggerBaseProperties"
},
"type": {
"enum": [
"custom_javascript"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"CustomMetricCondition": {
"properties": {
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/StringInArrayFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListRegexOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListSubstringFilter"
}
]
},
"property": {
"type": "string"
}
},
"required": [
"property",
"filter"
],
"type": "object"
},
"CustomMetricCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CustomMetricCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CustomMetricCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"definition": {
"$ref": "#/components/schemas/CustomMetricDefinition",
"description": "The definition of a custom metric. It is composed of a list of `metric_groups`. Each group specifies how to query a particular metric with customized filters and the value property to calculate conversion value measurements (if applicable). The groups are combined with `AND` relationships, i.e., conversion and conversion value measurements for each group will be added together to get the final result.",
"example": {
"aggregation_method": "value",
"metric_groups": [
{
"metric_filters": [
{
"filter": {
"operator": "starts-with",
"type": "string",
"value": "some_substring"
},
"property": "my_string_property"
},
{
"filter": {
"operator": "greater-than-or-equal",
"type": "numeric",
"value": 999
},
"property": "my_numeric_property"
}
],
"metric_id": "AAAAAA",
"value_property": "$value"
},
{
"metric_filters": [
{
"filter": {
"operator": "equals",
"type": "boolean",
"value": false
},
"property": "my_boolean_property"
},
{
"filter": {
"operator": "contains",
"type": "list",
"value": "some_value_in_a_list"
},
"property": "my_list_property"
}
],
"metric_id": "BBBBBB",
"value_property": "my_numeric_property"
}
]
}
},
"name": {
"description": "The name for this custom metric. Names must be unique across the account. Attempting to create a metric with a duplicate name will return a 400 status code.",
"example": "My custom metric",
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CustomMetricEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"CustomMetricDefinition": {
"properties": {
"aggregation_method": {
"description": "Method of aggregation for custom metric measurements. If a metric has a `value` aggregation method, it will be treated as a revenue metric, such as a Placed Order metric. If a metric has a `count` aggregation method, it will only be able to report on conversions like an Active on Site metric.\n",
"enum": [
"count",
"value"
],
"type": "string"
},
"metric_groups": {
"items": {
"$ref": "#/components/schemas/CustomMetricGroup"
},
"type": "array"
}
},
"required": [
"aggregation_method",
"metric_groups"
],
"type": "object"
},
"CustomMetricEnum": {
"enum": [
"custom-metric"
],
"type": "string"
},
"CustomMetricGroup": {
"properties": {
"metric_filters": {
"description": "An optional array of objects for filtering on properties of the metric.",
"items": {
"$ref": "#/components/schemas/CustomMetricCondition"
},
"nullable": true,
"type": "array"
},
"metric_id": {
"description": "The ID of the metric that composes the custom metric.",
"type": "string"
},
"value_property": {
"description": "\nIf the custom metric has a `value` aggregation method, the `value_property` of each `metric_group` of the `definition` should specify the property to calculate the conversion value. If null, the default `$value` property will be used.\n",
"nullable": true,
"type": "string"
}
},
"required": [
"metric_id"
],
"type": "object"
},
"CustomMetricPartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/CustomMetricPartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"CustomMetricPartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"definition": {
"$ref": "#/components/schemas/CustomMetricDefinition",
"description": "The definition of a custom metric. It is composed of a list of `metric_groups`. Each group specifies how to query a particular metric with customized filters and the value property to calculate conversion value measurements (if applicable). The groups are combined with `AND` relationships, i.e., conversion and conversion value measurements for each group will be added together to get the final result.",
"example": {
"aggregation_method": "value",
"metric_groups": [
{
"metric_filters": [
{
"filter": {
"operator": "starts-with",
"type": "string",
"value": "some_substring"
},
"property": "my_string_property"
},
{
"filter": {
"operator": "greater-than-or-equal",
"type": "numeric",
"value": 999
},
"property": "my_numeric_property"
}
],
"metric_id": "AAAAAA",
"value_property": "$value"
},
{
"metric_filters": [
{
"filter": {
"operator": "equals",
"type": "boolean",
"value": false
},
"property": "my_boolean_property"
},
{
"filter": {
"operator": "contains",
"type": "list",
"value": "some_value_in_a_list"
},
"property": "my_list_property"
}
],
"metric_id": "BBBBBB",
"value_property": "my_numeric_property"
}
]
},
"nullable": true
},
"name": {
"description": "The name for this custom metric. Names must be unique across the account. Attempting to create a metric with a duplicate name will return a 400 status code.",
"example": "My custom metric",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The ID of the custom metric",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CustomMetricEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"CustomMetricResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "The datetime when this custom metric was created.",
"example": "2025-04-15T00:00:00Z",
"format": "date-time",
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/CustomMetricDefinition",
"description": "The definition of a custom metric. It is composed of a list of `metric_groups`. Each group specifies how to query a particular metric with customized filters and the value property to calculate conversion value measurements (if applicable). The groups are combined with `AND` relationships, i.e., conversion and conversion value measurements for each group will be added together to get the final result.",
"example": {
"aggregation_method": "value",
"metric_groups": [
{
"metric_filters": [
{
"filter": {
"operator": "starts-with",
"type": "string",
"value": "some_substring"
},
"property": "my_string_property"
},
{
"filter": {
"operator": "greater-than-or-equal",
"type": "numeric",
"value": 999
},
"property": "my_numeric_property"
}
],
"metric_id": "AAAAAA",
"value_property": "$value"
},
{
"metric_filters": [
{
"filter": {
"operator": "equals",
"type": "boolean",
"value": false
},
"property": "my_boolean_property"
},
{
"filter": {
"operator": "contains",
"type": "list",
"value": "some_value_in_a_list"
},
"property": "my_list_property"
}
],
"metric_id": "BBBBBB",
"value_property": "my_numeric_property"
}
]
}
},
"name": {
"description": "The name for this custom metric. Names must be unique across the account. Attempting to create a metric with a duplicate name will return a 400 status code.",
"example": "My custom metric",
"type": "string"
},
"updated": {
"description": "The datetime when this custom metric was updated.",
"example": "2025-04-15T00:00:00Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"created",
"updated",
"definition"
],
"type": "object"
},
"id": {
"description": "The ID of the custom metric",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"metrics": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Related metrics",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CustomMetricEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"CustomObjectDateTrigger": {
"properties": {
"custom_object_label": {
"type": "string"
},
"custom_object_property_id": {
"type": "integer"
},
"date_field_type": {
"enum": [
"custom-object"
],
"type": "string"
},
"object_type_id": {
"type": "string"
},
"object_type_relationship_id": {
"type": "string"
},
"recurrence_frequency": {
"default": "monthly",
"description": "aka RepeatTypes in app and RepeatType in fender.",
"enum": [
"annually",
"monthly",
"never",
"weekly"
],
"example": "monthly",
"type": "string"
},
"timedelta_unit_before_date": {
"default": "weeks",
"description": "See FlowDateTrigger.UNIT_CHOICES in app and CountdownUnit in fender.",
"enum": [
"days",
"months",
"weeks"
],
"example": "weeks",
"type": "string"
},
"timedelta_value_before_date": {
"type": "integer"
},
"timezone": {
"default": "profile",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC",
"profile"
],
"example": "profile",
"type": "string"
},
"trigger_days": {
"items": {
"description": "Days of the week.",
"enum": [
"friday",
"monday",
"saturday",
"sunday",
"thursday",
"tuesday",
"wednesday"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"trigger_time": {
"format": "time",
"type": "string"
},
"type": {
"enum": [
"date"
],
"type": "string"
}
},
"required": [
"type",
"date_field_type",
"custom_object_label",
"custom_object_property_id",
"object_type_id",
"object_type_relationship_id",
"timedelta_value_before_date",
"trigger_time"
],
"type": "object"
},
"CustomObjectPropertyCondition": {
"properties": {
"custom_object_label": {
"type": "string"
},
"field": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
},
"type": {
"enum": [
"custom-object-property"
],
"type": "string"
}
},
"required": [
"type",
"custom_object_label",
"field",
"filter"
],
"type": "object"
},
"CustomObjectTriggerCondition": {
"properties": {
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
},
"property_id": {
"type": "integer"
},
"type": {
"enum": [
"custom-object-trigger-property"
],
"type": "string"
}
},
"required": [
"type",
"property_id",
"filter"
],
"type": "object"
},
"CustomQuestionDTO": {
"properties": {
"answers": {
"description": "The answers to the custom question",
"example": [
"M",
"L"
],
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "The ID of the custom question",
"example": "9ff0d32e-0edb-4513-a6a5-12814a6cb755",
"type": "string"
}
},
"required": [
"id",
"answers"
],
"type": "object"
},
"CustomSourceFilter": {
"properties": {
"field": {
"enum": [
"custom_source"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/EqualsStringFilter"
}
},
"required": [
"field",
"filter"
],
"type": "object"
},
"CustomTimeframe": {
"properties": {
"end": {
"description": "A datetime that represents the end of a custom time frame. Offset is ignored and the company timezone is used.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"start": {
"description": "A datetime that represents the start of a custom time frame. Offset is ignored and the company timezone is used.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"start",
"end"
],
"type": "object"
},
"CustomTrackingParamDTO": {
"properties": {
"campaign": {
"description": "The value of the tracking parameter when applied to a campaign.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CampaignTrackingSettingDynamicParam"
},
{
"$ref": "#/components/schemas/CampaignTrackingSettingStaticParam"
}
]
},
"flow": {
"description": "The value of the tracking parameter when applied to a flow.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/FlowTrackingSettingDynamicParam"
},
{
"$ref": "#/components/schemas/FlowTrackingSettingStaticParam"
}
]
},
"name": {
"description": "The name of the custom tracking parameter",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"DataPrivacyCreateDeletionJobQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/DataPrivacyCreateDeletionJobQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"DataPrivacyCreateDeletionJobQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"profile": {
"properties": {
"data": {
"$ref": "#/components/schemas/DataPrivacyProfileQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"profile"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/DataPrivacyDeletionJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"DataPrivacyDeletionJobEnum": {
"enum": [
"data-privacy-deletion-job"
],
"type": "string"
},
"DataPrivacyProfileQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"nullable": true,
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"DataSourceCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/DataSourceCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"DataSourceCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"description": {
"default": "",
"nullable": true,
"type": "string"
},
"namespace": {
"default": "custom-objects",
"description": "The namespace of the data source.",
"example": "custom-objects",
"nullable": true,
"type": "string"
},
"title": {
"description": "The title of the data source. Must be between 1 and 255 characters and unique within the namespace.",
"type": "string"
},
"visibility": {
"default": "private",
"description": "Visibility of data source.",
"enum": [
"private",
"shared"
],
"example": "private",
"nullable": true,
"type": "string"
}
},
"required": [
"title"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/DataSourceEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"DataSourceEnum": {
"enum": [
"data-source"
],
"type": "string"
},
"DataSourceRecordBulkCreateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/DataSourceRecordBulkCreateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"DataSourceRecordBulkCreateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"data-source-records": {
"description": "The records to ingest.",
"example": {
"data": [
{
"attributes": {
"record": {
"key1": "value1",
"key2": "value2"
}
},
"type": "data-source-record"
}
]
},
"nullable": true,
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DataSourceRecordResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"type": "object"
},
"relationships": {
"properties": {
"data-source": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The data source to which the records belong.",
"example": "01J7C23V8XWMRG13FMD7VZN6GW",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/DataSourceEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/DataSourceRecordBulkCreateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"DataSourceRecordBulkCreateJobEnum": {
"enum": [
"data-source-record-bulk-create-job"
],
"type": "string"
},
"DataSourceRecordCreateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/DataSourceRecordCreateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"DataSourceRecordCreateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"data-source-record": {
"description": "The records to ingest.",
"example": {
"data": {
"attributes": {
"record": {
"key1": "value1",
"key2": "value2"
}
},
"type": "data-source-record"
}
},
"properties": {
"data": {
"$ref": "#/components/schemas/DataSourceRecordResourceObject"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"data-source-record"
],
"type": "object"
},
"relationships": {
"properties": {
"data-source": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The data source to which the records belong.",
"example": "01J7C23V8XWMRG13FMD7VZN6GW",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/DataSourceEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/DataSourceRecordCreateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"DataSourceRecordCreateJobEnum": {
"enum": [
"data-source-record-create-job"
],
"type": "string"
},
"DataSourceRecordEnum": {
"enum": [
"data-source-record"
],
"type": "string"
},
"DataSourceRecordResourceObject": {
"properties": {
"attributes": {
"properties": {
"record": {
"type": "object"
}
},
"required": [
"record"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/DataSourceRecordEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"DataSourceResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"description": {
"description": "The description of the data source",
"example": "This is a data source",
"type": "string"
},
"namespace": {
"description": "The namespace of the data source",
"example": "custom-objects",
"type": "string"
},
"title": {
"description": "The title of the data source",
"example": "My Data Source",
"type": "string"
},
"visibility": {
"description": "The status of the data source",
"enum": [
"private",
"shared"
],
"type": "string"
}
},
"required": [
"title",
"visibility",
"description",
"namespace"
],
"type": "object"
},
"id": {
"description": "The ID of the data source",
"example": "01KH1D6P9Y8TJ7Q6MHXWZMPDN3",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/DataSourceEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"DataWarehouseImportMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"data_warehouse_import"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"Date": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/DateProperties"
},
"styles": {
"$ref": "#/components/schemas/DateStyles"
},
"type": {
"enum": [
"date"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"DateProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"date_format": {
"default": "MM/DD",
"example": "MM/DD",
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"placeholder": {
"nullable": true,
"type": "string"
},
"property_name": {
"type": "string"
},
"required": {
"default": false,
"nullable": true,
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
}
},
"required": [
"property_name"
],
"type": "object"
},
"DateStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"Delay": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/DelayProperties"
},
"type": {
"enum": [
"delay"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"DelayProperties": {
"properties": {
"seconds": {
"default": 5,
"example": 5,
"type": "integer"
}
},
"type": "object"
},
"Device": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/DeviceProperties"
},
"type": {
"enum": [
"device"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"DeviceMetadata": {
"properties": {
"app_build": {
"description": "The build of the app that created the push token",
"example": "1",
"nullable": true,
"type": "string"
},
"app_id": {
"description": "The ID of the app that created the push token",
"example": "com.klaviyo.app",
"nullable": true,
"type": "string"
},
"app_name": {
"description": "The name of the app that created the push token",
"example": "Klaviyo",
"nullable": true,
"type": "string"
},
"app_version": {
"description": "The version of the app that created the push token",
"example": "1.0.0",
"nullable": true,
"type": "string"
},
"device_id": {
"description": "Relatively stable ID for the device. Will update on app uninstall and reinstall",
"example": "1234567890",
"nullable": true,
"type": "string"
},
"device_model": {
"description": "The model of the device",
"example": "iPhone12,1",
"nullable": true,
"type": "string"
},
"environment": {
"description": "The environment in which the push token was created",
"enum": [
"debug",
"release"
],
"example": "release",
"nullable": true,
"type": "string"
},
"klaviyo_sdk": {
"description": "The name of the SDK used to create the push token.",
"enum": [
"android",
"flutter",
"flutter_community",
"react_native",
"swift"
],
"example": "swift",
"nullable": true,
"type": "string"
},
"manufacturer": {
"description": "The manufacturer of the device",
"example": "Apple",
"nullable": true,
"type": "string"
},
"os_name": {
"description": "The name of the operating system on the device.",
"enum": [
"android",
"ios",
"ipados",
"macos",
"tvos"
],
"example": "ios",
"nullable": true,
"type": "string"
},
"os_version": {
"description": "The version of the operating system on the device",
"example": "14.0",
"nullable": true,
"type": "string"
},
"sdk_version": {
"description": "The version of the SDK used to create the push token",
"example": "1.0.0",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"DeviceProperties": {
"properties": {
"device": {
"default": "desktop",
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"example": "desktop",
"type": "string"
}
},
"type": "object"
},
"DisplayOptions": {
"properties": {
"content_repeat": {
"$ref": "#/components/schemas/ContentRepeatV1",
"nullable": true
},
"layout_config": {
"nullable": true,
"type": "object"
},
"layout_type": {
"nullable": true,
"type": "string"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"visibility": {
"$ref": "#/components/schemas/Visibility",
"nullable": true
}
},
"type": "object"
},
"DoubleOptinFilter": {
"properties": {
"field": {
"enum": [
"is_double_opt_in"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/BooleanFilter"
}
},
"required": [
"field",
"filter"
],
"type": "object"
},
"DropShadow": {
"properties": {
"blur": {
"default": 30,
"example": 30,
"type": "integer"
},
"color": {
"default": "rgba(0,0,0,0.15)",
"example": "rgba(0,0,0,0.15)",
"nullable": true,
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
"DropShadowBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"styles": {
"$ref": "#/components/schemas/DropShadowBlockStyles"
}
},
"required": [
"display_options",
"styles"
],
"type": "object"
},
"DropShadowBlockStyles": {
"properties": {
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"mobile_stretch_content": {
"nullable": true,
"type": "boolean"
},
"shadow_color": {
"description": "Shadow color.",
"enum": [
"dark",
"light",
"medium"
],
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"DropShadowBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true
},
"type": {
"enum": [
"drop_shadow"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"DropShadowBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/DropShadowBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"drop_shadow"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"Dropdown": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/DropdownProperties"
},
"styles": {
"$ref": "#/components/schemas/DropdownStyles"
},
"type": {
"enum": [
"dropdown"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"DropdownProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"options": {
"items": {
"$ref": "#/components/schemas/PropertyOption"
},
"type": "array"
},
"placeholder": {
"nullable": true,
"type": "string"
},
"property_name": {
"type": "string"
},
"required": {
"default": false,
"nullable": true,
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
}
},
"required": [
"property_name",
"options"
],
"type": "object"
},
"DropdownStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"DynamicButton": {
"properties": {
"data": {
"$ref": "#/components/schemas/BackInStockDynamicButtonData"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"type": {
"description": "Dynamic Button type enumeration.",
"enum": [
"BACK_IN_STOCK_OPEN"
],
"type": "string"
}
},
"required": [
"type",
"data"
],
"type": "object"
},
"DynamicImageBlockProperties": {
"properties": {
"alt_text": {
"nullable": true,
"type": "string"
},
"dynamic": {
"enum": [
true
],
"type": "boolean"
},
"href": {
"nullable": true,
"type": "string"
},
"src": {
"nullable": true,
"type": "string"
}
},
"required": [
"dynamic"
],
"type": "object"
},
"DynamicProductBlockProperties": {
"properties": {
"button_text": {
"nullable": true,
"type": "string"
},
"dynamic": {
"enum": [
true
],
"type": "boolean"
},
"feed": {
"nullable": true,
"type": "string"
},
"feed_offset": {
"nullable": true,
"type": "integer"
},
"is_ai_generated": {
"nullable": true,
"type": "boolean"
},
"is_nbp": {
"nullable": true,
"type": "boolean"
},
"is_prebuilt_content": {
"nullable": true,
"type": "boolean"
},
"item_subtype_id": {
"nullable": true,
"type": "integer"
},
"show_button": {
"nullable": true,
"type": "boolean"
},
"show_original_price": {
"nullable": true,
"type": "boolean"
},
"show_price": {
"nullable": true,
"type": "boolean"
},
"show_rating": {
"nullable": true,
"type": "boolean"
},
"show_rating_count": {
"nullable": true,
"type": "boolean"
},
"show_title": {
"nullable": true,
"type": "boolean"
},
"show_title_links": {
"nullable": true,
"type": "boolean"
},
"title_placeholder": {
"nullable": true,
"type": "string"
}
},
"required": [
"dynamic"
],
"type": "object"
},
"DynamicReviewBlockProperties": {
"properties": {
"author_placeholder": {
"nullable": true,
"type": "string"
},
"dynamic": {
"enum": [
true
],
"type": "boolean"
},
"fallback_content_type": {
"description": "Review block fallback content type.",
"enum": [
"full",
"quote"
],
"nullable": true,
"type": "string"
},
"fallback_options": {
"description": "Review block fallback options for dynamic selection.",
"enum": [
"high-quality-review",
"high-quality-review-or-static",
"no-review",
"recent",
"static-only"
],
"nullable": true,
"type": "string"
},
"fallback_review_id": {
"nullable": true,
"type": "string"
},
"product_event_variable": {
"nullable": true,
"type": "string"
},
"product_id": {
"nullable": true,
"type": "string"
},
"product_name_placeholder": {
"nullable": true,
"type": "string"
},
"product_selection_mode": {
"description": "Review block product selection mode.",
"enum": [
"automatic",
"manual"
],
"nullable": true,
"type": "string"
},
"product_variant_name_placeholder": {
"nullable": true,
"type": "string"
},
"quote_placeholder": {
"nullable": true,
"type": "string"
},
"show_product_name": {
"nullable": true,
"type": "boolean"
},
"show_rating": {
"nullable": true,
"type": "boolean"
},
"show_reviewer_name": {
"nullable": true,
"type": "boolean"
},
"show_variant_name": {
"nullable": true,
"type": "boolean"
},
"show_verified_badge": {
"nullable": true,
"type": "boolean"
},
"verified_badge_language": {
"description": "Review block verified badge language.",
"enum": [
"dutch",
"english",
"french",
"german",
"hungarian",
"italian",
"japanese",
"korean",
"portuguese",
"spanish"
],
"nullable": true,
"type": "string"
}
},
"required": [
"dynamic"
],
"type": "object"
},
"DynamicTableBlockProperties": {
"properties": {
"dynamic": {
"enum": [
true
],
"type": "boolean"
},
"num_columns": {
"nullable": true,
"type": "integer"
},
"row_content_repeat": {
"$ref": "#/components/schemas/ContentRepeatV1",
"nullable": true
},
"show_fallback_content": {
"nullable": true,
"type": "boolean"
},
"show_headers": {
"nullable": true,
"type": "boolean"
},
"show_static_row": {
"nullable": true,
"type": "boolean"
}
},
"required": [
"dynamic"
],
"type": "object"
},
"DynamicTrackingParam": {
"properties": {
"name": {
"description": "Name of the tracking param",
"example": "utm_medium",
"type": "string"
},
"type": {
"description": "The type of the tracking parameter",
"enum": [
"dynamic"
],
"type": "string"
},
"value": {
"description": "The value of the tracking parameter",
"enum": [
"campaign_id",
"campaign_name",
"campaign_name_id",
"campaign_name_send_day",
"email_subject",
"group_id",
"group_name",
"group_name_id",
"link_alt_text",
"message_type",
"profile_external_id",
"profile_id"
],
"type": "string"
}
},
"required": [
"type",
"value",
"name"
],
"type": "object"
},
"EffectiveDateFilter": {
"properties": {
"field": {
"enum": [
"effective_date"
],
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
}
]
}
},
"required": [
"field",
"filter"
],
"type": "object"
},
"Email": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/EmailProperties"
},
"styles": {
"$ref": "#/components/schemas/EmailStyles"
},
"type": {
"enum": [
"email"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"EmailChannel": {
"properties": {
"marketing": {
"$ref": "#/components/schemas/EmailMarketing",
"description": "The email marketing subscription.",
"nullable": true
}
},
"type": "object"
},
"EmailContent": {
"properties": {
"bcc_email": {
"description": "Optional BCC email address",
"example": "bcc@my-company.com",
"nullable": true,
"type": "string"
},
"cc_email": {
"description": "Optional CC email address",
"example": "cc@my-company.com",
"nullable": true,
"type": "string"
},
"from_email": {
"description": "The email the message should be sent from",
"example": "store@my-company.com",
"nullable": true,
"type": "string"
},
"from_label": {
"description": "The label associated with the from_email",
"example": "My Company",
"nullable": true,
"type": "string"
},
"preview_text": {
"description": "Preview text associated with the message",
"example": "My preview text",
"nullable": true,
"type": "string"
},
"reply_to_email": {
"description": "Optional Reply-To email address",
"example": "reply-to@my-company.com",
"nullable": true,
"type": "string"
},
"subject": {
"description": "The subject of the message",
"example": "Buy our product!",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EmailContentSubObject": {
"properties": {
"bcc_email": {
"description": "Optional BCC email address",
"example": "bcc@my-company.com",
"nullable": true,
"type": "string"
},
"cc_email": {
"description": "Optional CC email address",
"example": "cc@my-company.com",
"nullable": true,
"type": "string"
},
"from_email": {
"description": "The email the message should be sent from",
"example": "store@my-company.com",
"nullable": true,
"type": "string"
},
"from_label": {
"description": "The label associated with the from_email",
"example": "My Company",
"nullable": true,
"type": "string"
},
"preview_text": {
"description": "Preview text associated with the message",
"example": "My preview text",
"nullable": true,
"type": "string"
},
"reply_to_email": {
"description": "Optional Reply-To email address",
"example": "reply-to@my-company.com",
"nullable": true,
"type": "string"
},
"subject": {
"description": "The subject of the message",
"example": "Buy our product!",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EmailMarketing": {
"properties": {
"can_receive_email_marketing": {
"description": "Whether or not this profile has implicit consent to receive email marketing. True if it does profile does not have any global suppressions.",
"type": "boolean"
},
"consent": {
"description": "The consent status for email marketing.",
"example": "SUBSCRIBED",
"type": "string"
},
"consent_timestamp": {
"description": "The timestamp when consent was recorded or updated for email marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"custom_method_detail": {
"description": "Additional detail provided by the caller when the profile was subscribed. This may be empty if no details were provided.",
"example": "marketing drive",
"nullable": true,
"type": "string"
},
"double_optin": {
"description": "Whether the profile was subscribed to email marketing using a double opt-in.",
"example": true,
"nullable": true,
"type": "boolean"
},
"last_updated": {
"description": "The timestamp when a field on the email marketing object was last modified.",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"list_suppressions": {
"description": "The list suppressions for this profile.",
"items": {
"$ref": "#/components/schemas/EmailMarketingListSuppression"
},
"nullable": true,
"type": "array"
},
"method": {
"description": "The method by which the profile was subscribed to email marketing.",
"example": "PREFERENCE_PAGE",
"nullable": true,
"type": "string"
},
"method_detail": {
"default": "",
"description": "Additional details about the method by which the profile was subscribed to email marketing. This may be empty if no details were provided.",
"example": "mydomain.com/signup",
"nullable": true,
"type": "string"
},
"suppression": {
"description": "The global email marketing suppression for this profile.",
"items": {
"$ref": "#/components/schemas/EmailMarketingSuppression"
},
"nullable": true,
"type": "array"
}
},
"required": [
"can_receive_email_marketing",
"consent"
],
"type": "object"
},
"EmailMarketingListSuppression": {
"properties": {
"list_id": {
"description": "The ID of list to which the suppression applies.",
"example": "Y6nRLr",
"type": "string"
},
"reason": {
"description": "The reason the profile was suppressed from the list.",
"example": "USER_SUPPRESSED",
"type": "string"
},
"timestamp": {
"description": "The timestamp when the profile was suppressed from the list, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"list_id",
"reason",
"timestamp"
],
"type": "object"
},
"EmailMarketingSuppression": {
"properties": {
"reason": {
"description": "The reason the profile was suppressed.",
"enum": [
"HARD_BOUNCE",
"INVALID_EMAIL",
"SPAM_COMPLAINT",
"UNSUBSCRIBE",
"USER_SUPPRESSED"
],
"example": "HARD_BOUNCE",
"type": "string"
},
"timestamp": {
"description": "The timestamp when the profile was suppressed, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"reason",
"timestamp"
],
"type": "object"
},
"EmailMessageDefinition": {
"properties": {
"channel": {
"enum": [
"email"
],
"type": "string"
},
"content": {
"$ref": "#/components/schemas/EmailContent",
"description": "Additional attributes relating to the content of the message",
"nullable": true
},
"label": {
"description": "The label or name on the message",
"example": "My message name",
"nullable": true,
"type": "string"
}
},
"required": [
"channel"
],
"type": "object"
},
"EmailProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"placeholder": {
"nullable": true,
"type": "string"
},
"property_name": {
"default": "$email",
"enum": [
"$email"
],
"example": "$email",
"type": "string"
},
"required": {
"default": false,
"nullable": true,
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
"EmailSendOptions": {
"properties": {
"use_smart_sending": {
"default": true,
"description": "Use smart sending.",
"example": true,
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"EmailStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"EmailSubscriptionParameters": {
"properties": {
"marketing": {
"$ref": "#/components/schemas/SubscriptionParameters",
"description": "The parameters to subscribe to on the \"EMAIL\" Channel. Currently supports \"MARKETING\"."
}
},
"required": [
"marketing"
],
"type": "object"
},
"EmailUnsubscriptionParameters": {
"properties": {
"marketing": {
"$ref": "#/components/schemas/UnsubscriptionParameters",
"description": "The parameters to unsubscribe from marketing on the \"EMAIL\" channel."
}
},
"required": [
"marketing"
],
"type": "object"
},
"EncodedFormResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"ab_test": {
"description": "Whether the form has an A/B test configured.",
"type": "boolean"
},
"created_at": {
"description": "The ISO8601 timestamp when the form was created.",
"example": "2024-03-04T00:00:00Z",
"format": "date-time",
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/FormDefinition",
"description": "The encoded form definition."
},
"name": {
"description": "The name of the form.",
"example": "Cyber Monday Deals",
"type": "string"
},
"status": {
"description": "The status of the form.",
"enum": [
"draft",
"live"
],
"example": "draft",
"type": "string"
},
"updated_at": {
"description": "The ISO8601 timestamp when the form was last updated.",
"example": "2024-03-04T00:00:00Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"status",
"ab_test",
"name",
"definition",
"created_at",
"updated_at"
],
"type": "object"
},
"id": {
"description": "The ID of the form",
"example": "Y6nRLr",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/FormEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"EqualsStringFilter": {
"properties": {
"operator": {
"enum": [
"equals"
],
"type": "string"
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ErrorMessages": {
"properties": {
"invalid": {
"default": "This field is invalid",
"example": "This field is invalid",
"type": "string"
},
"required": {
"default": "This field is required",
"example": "This field is required",
"type": "string"
}
},
"type": "object"
},
"ErrorSource": {
"properties": {
"pointer": {
"default": "/data",
"description": "A pointer to the source of the error in the request payload.",
"example": "/data",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"EventBulkCreateEnum": {
"enum": [
"event-bulk-create"
],
"type": "string"
},
"EventBulkCreateJobEnum": {
"enum": [
"event-bulk-create-job"
],
"type": "string"
},
"EventCreateQueryV2": {
"properties": {
"data": {
"$ref": "#/components/schemas/EventCreateQueryV2ResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"EventCreateQueryV2ResourceObject": {
"properties": {
"attributes": {
"properties": {
"backfill": {
"default": false,
"description": "When true, the event is recorded but does NOT trigger flows. Use this when backfilling\nhistorical events so existing flow definitions do not re-fire on events that already\nfired in the past.",
"nullable": true,
"type": "boolean"
},
"metric": {
"properties": {
"data": {
"$ref": "#/components/schemas/MetricCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"profile": {
"properties": {
"data": {
"$ref": "#/components/schemas/EventProfileCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"properties": {
"description": "Properties of this event (must not exceed 400 properties). The size of the event payload must not exceed 5 MB,\nand each string cannot be larger than 100 KB. For a full list of data limits on event payloads,\nsee [Limitations](https://developers.klaviyo.com/en/reference/events_api_overview#limitations).\n\nNote any top-level property that is not an object can be\nused to create segments. The `$extra` property records any\nnon-segmentable values that can be referenced later, e.g., HTML templates are\nuseful on a segment but are not used to create a segment.",
"example": {
"Brand": "Kids Book",
"ProductID": 1111,
"ProductName": "Winnie the Pooh"
},
"type": "object"
},
"time": {
"description": "When this event occurred. By default, the time the request was received will be used.\nThe time is truncated to the second. The time must be after the year 2000 and can only\nbe up to 1 year in the future.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"unique_id": {
"description": "A unique identifier for an event. If the unique_id is repeated for the same\nprofile and metric, only the first processed event will be recorded. If this is not\npresent, this will use the time to the second. Using the default, this limits only one\nevent per profile per second.",
"nullable": true,
"type": "string"
},
"value": {
"description": "A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.",
"example": 9.99,
"nullable": true,
"type": "number"
},
"value_currency": {
"description": "The ISO 4217 currency code of the value associated with the event.",
"example": "USD",
"nullable": true,
"type": "string"
}
},
"required": [
"properties",
"metric",
"profile"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/EventEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"EventEnum": {
"enum": [
"event"
],
"type": "string"
},
"EventProfileCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"_kx": {
"description": "Also known as the `exchange_id`, this is an encrypted identifier used for identifying a\nprofile by Klaviyo's web tracking.\n\nYou can use this field as a filter when retrieving profiles via the Get Profiles endpoint.",
"nullable": true,
"type": "string"
},
"anonymous_id": {
"nullable": true,
"type": "string"
},
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"meta": {
"$ref": "#/components/schemas/OnsiteProfileMeta",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"nullable": true,
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"EventResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"datetime": {
"description": "Event timestamp in ISO8601 format (YYYY-MM-DDTHH:MM:SS+hh:mm)",
"example": "2022-11-08T01:23:45+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"event_properties": {
"description": "Event properties, can include identifiers and extra properties",
"nullable": true,
"type": "object"
},
"timestamp": {
"description": "Event timestamp in seconds",
"nullable": true,
"type": "integer"
},
"uuid": {
"description": "A unique identifier for the event, this can be used as a cursor in pagination",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The Event ID",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"attributions": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Attributions for this event",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/AttributionEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"metric": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The Metric ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profile": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Profile ID of the associated profile, if available",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/EventEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"EventsBulkCreateJob": {
"properties": {
"data": {
"$ref": "#/components/schemas/EventsBulkCreateJobResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"EventsBulkCreateJobResourceObject": {
"properties": {
"attributes": {
"properties": {
"events-bulk-create": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EventsBulkCreateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"events-bulk-create"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/EventBulkCreateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"EventsBulkCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/EventsBulkCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"EventsBulkCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"backfill": {
"default": false,
"description": "When true, the event is recorded but does NOT trigger flows. Use this when backfilling\nhistorical events so existing flow definitions do not re-fire on events that already\nfired in the past.",
"nullable": true,
"type": "boolean"
},
"events": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/BaseEventCreateQueryBulkEntryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"profile": {
"properties": {
"data": {
"$ref": "#/components/schemas/OnsiteProfileCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"profile",
"events"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/EventBulkCreateEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ExistenceOperatorExistenceFilter": {
"properties": {
"operator": {
"description": "Operators for existence filters.",
"enum": [
"is-set",
"not-set"
],
"type": "string"
},
"type": {
"enum": [
"existence"
],
"type": "string"
}
},
"required": [
"type",
"operator"
],
"type": "object"
},
"ExitIntent": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/TriggerBaseProperties"
},
"type": {
"enum": [
"exit_intent"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ExplicitlyReachable": {
"properties": {
"filters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/EffectiveDateFilter"
},
{
"$ref": "#/components/schemas/RecordedDateFilter"
},
{
"$ref": "#/components/schemas/MethodFilter"
},
{
"$ref": "#/components/schemas/FormSubscribeFilter"
}
]
},
"type": "array"
},
"reachable_status": {
"enum": [
"explicitly_reachable"
],
"type": "string"
}
},
"required": [
"reachable_status",
"filters"
],
"type": "object"
},
"ExplicitlyUnreachable": {
"properties": {
"filters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/EffectiveDateFilter"
},
{
"$ref": "#/components/schemas/RecordedDateFilter"
},
{
"$ref": "#/components/schemas/MethodFilter"
},
{
"$ref": "#/components/schemas/FormSubscribeFilter"
}
]
},
"type": "array"
},
"reachable_status": {
"enum": [
"explicitly_unreachable"
],
"type": "string"
}
},
"required": [
"reachable_status",
"filters"
],
"type": "object"
},
"FailedAgeGateMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"failed_age_gate"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"FixedTimerConfiguration": {
"properties": {
"end_time": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"timezone": {
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Asmera",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Timbuktu",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/ComodRivadavia",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Atka",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Buenos_Aires",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Catamarca",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Coral_Harbour",
"America/Cordoba",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Ensenada",
"America/Fort_Nelson",
"America/Fort_Wayne",
"America/Fortaleza",
"America/Glace_Bay",
"America/Godthab",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Indianapolis",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Jujuy",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Knox_IN",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Louisville",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Mendoza",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montreal",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nipigon",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Pangnirtung",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Acre",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rainy_River",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Rosario",
"America/Santa_Isabel",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Shiprock",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Thunder_Bay",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Virgin",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"America/Yellowknife",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/South_Pole",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Ashkhabad",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Calcutta",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Chongqing",
"Asia/Chungking",
"Asia/Colombo",
"Asia/Dacca",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Harbin",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Istanbul",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kashgar",
"Asia/Kathmandu",
"Asia/Katmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macao",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Rangoon",
"Asia/Riyadh",
"Asia/Saigon",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Tel_Aviv",
"Asia/Thimbu",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ujung_Pandang",
"Asia/Ulaanbaatar",
"Asia/Ulan_Bator",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faeroe",
"Atlantic/Faroe",
"Atlantic/Jan_Mayen",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/ACT",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Canberra",
"Australia/Currie",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/LHI",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/NSW",
"Australia/North",
"Australia/Perth",
"Australia/Queensland",
"Australia/South",
"Australia/Sydney",
"Australia/Tasmania",
"Australia/Victoria",
"Australia/West",
"Australia/Yancowinna",
"Brazil/Acre",
"Brazil/DeNoronha",
"Brazil/East",
"Brazil/West",
"CET",
"CST6CDT",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Canada/Saskatchewan",
"Canada/Yukon",
"Chile/Continental",
"Chile/EasterIsland",
"Cuba",
"EET",
"EST",
"EST5EDT",
"Egypt",
"Eire",
"Etc/GMT",
"Etc/GMT+0",
"Etc/GMT+1",
"Etc/GMT+10",
"Etc/GMT+11",
"Etc/GMT+12",
"Etc/GMT+2",
"Etc/GMT+3",
"Etc/GMT+4",
"Etc/GMT+5",
"Etc/GMT+6",
"Etc/GMT+7",
"Etc/GMT+8",
"Etc/GMT+9",
"Etc/GMT-0",
"Etc/GMT-1",
"Etc/GMT-10",
"Etc/GMT-11",
"Etc/GMT-12",
"Etc/GMT-13",
"Etc/GMT-14",
"Etc/GMT-2",
"Etc/GMT-3",
"Etc/GMT-4",
"Etc/GMT-5",
"Etc/GMT-6",
"Etc/GMT-7",
"Etc/GMT-8",
"Etc/GMT-9",
"Etc/GMT0",
"Etc/Greenwich",
"Etc/UCT",
"Etc/UTC",
"Etc/Universal",
"Etc/Zulu",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belfast",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kiev",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Nicosia",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Tiraspol",
"Europe/Ulyanovsk",
"Europe/Uzhgorod",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zaporozhye",
"Europe/Zurich",
"GB",
"GB-Eire",
"GMT",
"GMT+0",
"GMT-0",
"GMT0",
"Greenwich",
"HST",
"Hongkong",
"Iceland",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Iran",
"Israel",
"Jamaica",
"Japan",
"Kwajalein",
"Libya",
"MET",
"MST",
"MST7MDT",
"Mexico/BajaNorte",
"Mexico/BajaSur",
"Mexico/General",
"NZ",
"NZ-CHAT",
"Navajo",
"PRC",
"PST8PDT",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Enderbury",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Johnston",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Ponape",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Samoa",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Truk",
"Pacific/Wake",
"Pacific/Wallis",
"Pacific/Yap",
"Poland",
"Portugal",
"ROC",
"ROK",
"Singapore",
"Turkey",
"UCT",
"US/Alaska",
"US/Aleutian",
"US/Arizona",
"US/Central",
"US/East-Indiana",
"US/Eastern",
"US/Hawaii",
"US/Indiana-Starke",
"US/Michigan",
"US/Mountain",
"US/Pacific",
"US/Samoa",
"UTC",
"Universal",
"W-SU",
"WET",
"Zulu"
],
"type": "string"
},
"type": {
"enum": [
"fixed"
],
"type": "string"
}
},
"required": [
"type",
"timezone"
],
"type": "object"
},
"FlowActionEncodedResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"description": "The encoded flow action definition.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ActionOutputSplitAction"
},
{
"$ref": "#/components/schemas/BackInStockDelayAction"
},
{
"$ref": "#/components/schemas/ConditionalBranchAction"
},
{
"$ref": "#/components/schemas/ContentExperimentAction"
},
{
"$ref": "#/components/schemas/SendEmailAction"
},
{
"$ref": "#/components/schemas/SendPushNotificationAction"
},
{
"$ref": "#/components/schemas/SendSmsAction"
},
{
"$ref": "#/components/schemas/SendWebhookAction"
},
{
"$ref": "#/components/schemas/SendInternalAlertAction"
},
{
"$ref": "#/components/schemas/SendWhatsAppAction"
},
{
"$ref": "#/components/schemas/TimeDelayAction"
},
{
"$ref": "#/components/schemas/TriggerBranchAction"
},
{
"$ref": "#/components/schemas/UpdateProfileAction"
},
{
"$ref": "#/components/schemas/TargetDateAction"
},
{
"$ref": "#/components/schemas/CountdownDelayAction"
},
{
"$ref": "#/components/schemas/AbTestAction"
},
{
"$ref": "#/components/schemas/InternalServiceAction"
},
{
"$ref": "#/components/schemas/CodeAction"
},
{
"$ref": "#/components/schemas/MultiBranchSplitAction"
},
{
"$ref": "#/components/schemas/ListUpdateAction"
}
]
},
"updated": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"flow-messages": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"FlowActionEnum": {
"enum": [
"flow-action"
],
"type": "string"
},
"FlowActionUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/FlowActionUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"FlowActionUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"definition": {
"description": "The encoded flow action definition.",
"oneOf": [
{
"$ref": "#/components/schemas/ActionOutputSplitAction"
},
{
"$ref": "#/components/schemas/BackInStockDelayAction"
},
{
"$ref": "#/components/schemas/ConditionalBranchAction"
},
{
"$ref": "#/components/schemas/ContentExperimentAction"
},
{
"$ref": "#/components/schemas/SendEmailAction"
},
{
"$ref": "#/components/schemas/SendPushNotificationAction"
},
{
"$ref": "#/components/schemas/SendSmsAction"
},
{
"$ref": "#/components/schemas/SendWebhookAction"
},
{
"$ref": "#/components/schemas/SendInternalAlertAction"
},
{
"$ref": "#/components/schemas/SendWhatsAppAction"
},
{
"$ref": "#/components/schemas/TimeDelayAction"
},
{
"$ref": "#/components/schemas/TriggerBranchAction"
},
{
"$ref": "#/components/schemas/UpdateProfileAction"
},
{
"$ref": "#/components/schemas/TargetDateAction"
},
{
"$ref": "#/components/schemas/CountdownDelayAction"
},
{
"$ref": "#/components/schemas/AbTestAction"
},
{
"$ref": "#/components/schemas/InternalServiceAction"
},
{
"$ref": "#/components/schemas/CodeAction"
},
{
"$ref": "#/components/schemas/MultiBranchSplitAction"
},
{
"$ref": "#/components/schemas/ListUpdateAction"
}
]
}
},
"required": [
"definition"
],
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"FlowCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/FlowCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"FlowCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"definition": {
"$ref": "#/components/schemas/FlowDefinition",
"description": "The encoded flow definition. New objects that do not yet exist, such as actions, need to use a `temporary_id`, not an `id`."
},
"name": {
"description": "The name of the Flow",
"example": "Welcome Flow",
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"FlowDefinition": {
"properties": {
"actions": {
"description": "A list of actions that make up the flow. Actions are linked to each other by their ids.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ActionOutputSplitAction"
},
{
"$ref": "#/components/schemas/BackInStockDelayAction"
},
{
"$ref": "#/components/schemas/ConditionalBranchAction"
},
{
"$ref": "#/components/schemas/ContentExperimentAction"
},
{
"$ref": "#/components/schemas/SendEmailAction"
},
{
"$ref": "#/components/schemas/SendPushNotificationAction"
},
{
"$ref": "#/components/schemas/SendSmsAction"
},
{
"$ref": "#/components/schemas/SendWebhookAction"
},
{
"$ref": "#/components/schemas/SendInternalAlertAction"
},
{
"$ref": "#/components/schemas/SendWhatsAppAction"
},
{
"$ref": "#/components/schemas/TimeDelayAction"
},
{
"$ref": "#/components/schemas/TriggerBranchAction"
},
{
"$ref": "#/components/schemas/UpdateProfileAction"
},
{
"$ref": "#/components/schemas/TargetDateAction"
},
{
"$ref": "#/components/schemas/CountdownDelayAction"
},
{
"$ref": "#/components/schemas/AbTestAction"
},
{
"$ref": "#/components/schemas/InternalServiceAction"
},
{
"$ref": "#/components/schemas/CodeAction"
},
{
"$ref": "#/components/schemas/MultiBranchSplitAction"
},
{
"$ref": "#/components/schemas/ListUpdateAction"
}
]
},
"type": "array"
},
"entry_action_id": {
"description": "The ID of the action that is the entry point of the flow.",
"example": "123",
"nullable": true,
"type": "string"
},
"profile_filter": {
"description": "Filters for users entering the flow. These filters are used on every action in the flow.",
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
},
{
"$ref": "#/components/schemas/ProfileNotInFlowCondition"
}
]
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"reentry_criteria": {
"$ref": "#/components/schemas/ReentryCriteria",
"description": "Controls when a customer can re-enter the flow. If unit is 'alltime', a duration of 1 means no re-entry, while a duration of 0 means re-entry is allowed.",
"nullable": true
},
"triggers": {
"description": "Corresponds to the object which triggers the flow. Only one trigger is supported.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ListTrigger"
},
{
"$ref": "#/components/schemas/SegmentTrigger"
},
{
"$ref": "#/components/schemas/MetricTrigger"
},
{
"$ref": "#/components/schemas/ProfilePropertyDateTrigger"
},
{
"$ref": "#/components/schemas/CustomObjectDateTrigger"
},
{
"$ref": "#/components/schemas/PriceDropTrigger"
},
{
"$ref": "#/components/schemas/LowInventoryTrigger"
}
]
},
"type": "array"
}
},
"required": [
"triggers",
"actions",
"entry_action_id"
],
"type": "object"
},
"FlowEmail": {
"properties": {
"add_tracking_params": {
"default": false,
"type": "boolean"
},
"additional_filters": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
},
{
"$ref": "#/components/schemas/ProfileHasNotReceivedEmailMessageCondition"
}
]
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"bcc_email": {
"nullable": true,
"type": "string"
},
"cc_email": {
"nullable": true,
"type": "string"
},
"custom_tracking_params": {
"items": {
"$ref": "#/components/schemas/UtmParam"
},
"nullable": true,
"type": "array"
},
"from_email": {
"nullable": true,
"type": "string"
},
"from_label": {
"nullable": true,
"type": "string"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"preview_text": {
"nullable": true,
"type": "string"
},
"reply_to_email": {
"nullable": true,
"type": "string"
},
"smart_sending_enabled": {
"default": true,
"example": true,
"type": "boolean"
},
"subject_line": {
"nullable": true,
"type": "string"
},
"template_id": {
"nullable": true,
"type": "string"
},
"transactional": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
"FlowEnum": {
"enum": [
"flow"
],
"type": "string"
},
"FlowInternalAlert": {
"properties": {
"from_email": {
"nullable": true,
"type": "string"
},
"from_label": {
"nullable": true,
"type": "string"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"subject_line": {
"nullable": true,
"type": "string"
},
"template_id": {
"nullable": true,
"type": "string"
},
"to_emails": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"from_email",
"from_label",
"to_emails",
"subject_line"
],
"type": "object"
},
"FlowMessageEncodedResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"channel": {
"nullable": true,
"type": "string"
},
"created": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"description": "The encoded flow message definition.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/FlowEmail"
},
{
"$ref": "#/components/schemas/FlowInternalAlert"
},
{
"$ref": "#/components/schemas/FlowPushNotification"
},
{
"$ref": "#/components/schemas/FlowSms"
},
{
"$ref": "#/components/schemas/FlowWebhook"
},
{
"$ref": "#/components/schemas/FlowWhatsApp"
}
]
},
"updated": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-action": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"template": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowMessageEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"FlowMessageEnum": {
"enum": [
"flow-message"
],
"type": "string"
},
"FlowPushNotification": {
"properties": {
"action_buttons": {
"items": {
"$ref": "#/components/schemas/PushActionButton"
},
"nullable": true,
"type": "array"
},
"additional_filters": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
},
{
"$ref": "#/components/schemas/ProfileHasNotReceivedPushMessageCondition"
}
]
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"android_link": {
"nullable": true,
"type": "string"
},
"badge": {
"default": false,
"type": "boolean"
},
"badge_options": {
"oneOf": [
{
"$ref": "#/components/schemas/Increment"
},
{
"$ref": "#/components/schemas/StaticCount"
},
{
"$ref": "#/components/schemas/Property"
}
]
},
"body": {
"type": "string"
},
"conversion_metric_id": {
"nullable": true,
"type": "string"
},
"dynamic_image": {
"description": "A dynamic image asset to include in the push notification.",
"example": "{{ event.items.0.url }}",
"nullable": true,
"type": "string"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"image_id": {
"description": "The id of an ImageAsset. If provided, this will take precedence over a dynamic_image.",
"example": "123",
"nullable": true,
"type": "string"
},
"ios_link": {
"nullable": true,
"type": "string"
},
"kv_pairs": {
"nullable": true,
"type": "object"
},
"name": {
"nullable": true,
"type": "string"
},
"on_open": {
"default": "home",
"description": "See PushLinkAction in app.\n\nThis is not a flow action, but the literal action that should be\n taken when the push notification is tapped.",
"enum": [
"home",
"link",
"open_url"
],
"example": "home",
"type": "string"
},
"push_type": {
"description": "The type of push notification to send.",
"enum": [
"silent",
"standard"
],
"nullable": true,
"type": "string"
},
"smart_sending_enabled": {
"default": true,
"example": true,
"type": "boolean"
},
"sound": {
"default": false,
"type": "boolean"
},
"title": {
"nullable": true,
"type": "string"
},
"video_asset_id": {
"description": "The ULID of a video asset. If provided, videos and images are mutually exclusive.",
"example": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
"nullable": true,
"type": "string"
},
"web_url": {
"nullable": true,
"type": "string"
}
},
"required": [
"body"
],
"type": "object"
},
"FlowResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"archived": {
"nullable": true,
"type": "boolean"
},
"created": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"trigger_type": {
"description": "Corresponds to the object which triggered the flow.",
"enum": [
"Added to List",
"Date Based",
"Low Inventory",
"Metric",
"Price Drop",
"Unconfigured"
],
"nullable": true,
"type": "string"
},
"updated": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-actions": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"FlowSeriesReportEnum": {
"enum": [
"flow-series-report"
],
"type": "string"
},
"FlowSeriesRequestDTO": {
"properties": {
"data": {
"$ref": "#/components/schemas/FlowSeriesRequestDTOResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"FlowSeriesRequestDTOResourceObject": {
"properties": {
"attributes": {
"properties": {
"conversion_metric_id": {
"description": "ID of the metric to be used for conversion statistics",
"example": "RESQ6t",
"type": "string"
},
"filter": {
"description": "API filter string used to filter the query.\nScalar attributes (flow_id, flow_name, send_channel, flow_message_id, flow_message_name, text_message_format, variation, variation_name): Supported operators: equals, contains-any.\nList attributes (tag_id, tag_name): Supported operators: contains-any, contains-all.\nOnly one filter can be used per attribute.\nOnly AND can be used as a combination operator.\nMax of 100 items per list filter.\nWhen filtering on send_channel, allowed values are email, sms, push-notification, whatsapp.",
"example": "and(equals(flow_id,\"abc123\"),contains-any(send_channel,[\"email\",\"sms\"]))",
"nullable": true,
"type": "string"
},
"group_by": {
"description": "List of attributes to group the data by.\nAllowed group-bys are flow_id, flow_message_id, flow_message_name, flow_name, send_channel, tag_id, tag_name, text_message_format, variation, variation_name.\nIf not passed in, the data will be grouped by flow_id, flow_message_id, send_channel.\nThe following group by attributes are required: flow_message_id, flow_id.",
"items": {
"description": "Attributes to represent what is being grouped by for Flows",
"enum": [
"flow_id",
"flow_message_id",
"flow_message_name",
"flow_name",
"send_channel",
"tag_id",
"tag_name",
"text_message_format",
"variation",
"variation_name"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"interval": {
"description": "The interval used to aggregate data within the series request.\nIf hourly is used, the timeframe cannot be longer than 7 days.\nIf daily is used, the timeframe cannot be longer than 60 days.\nIf monthly is used, the timeframe cannot be longer than 52 weeks.",
"enum": [
"daily",
"hourly",
"monthly",
"weekly"
],
"example": "weekly",
"type": "string"
},
"statistics": {
"description": "List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]",
"example": [
"opens",
"open_rate"
],
"items": {
"description": "Defined reporting metric",
"enum": [
"average_order_value",
"bounce_rate",
"bounced",
"bounced_or_failed",
"bounced_or_failed_rate",
"click_rate",
"click_to_open_rate",
"clicks",
"clicks_unique",
"conversion_rate",
"conversion_uniques",
"conversion_value",
"conversions",
"delivered",
"delivery_rate",
"failed",
"failed_rate",
"message_segment_count_sum",
"open_rate",
"opens",
"opens_unique",
"recipients",
"revenue_per_recipient",
"spam_complaint_rate",
"spam_complaints",
"text_message_credit_usage_amount",
"text_message_roi",
"text_message_spend",
"unsubscribe_rate",
"unsubscribe_uniques",
"unsubscribes"
],
"type": "string"
},
"type": "array"
},
"timeframe": {
"description": "The time frame to pull data from (Max length: 1 year). See [available time frames](https://developers.klaviyo.com/en/reference/reporting_api_overview#available-time-frames).",
"oneOf": [
{
"$ref": "#/components/schemas/Timeframe"
},
{
"$ref": "#/components/schemas/CustomTimeframe"
}
]
}
},
"required": [
"statistics",
"timeframe",
"interval",
"conversion_metric_id"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowSeriesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"FlowSms": {
"properties": {
"add_info_link": {
"default": true,
"example": true,
"type": "boolean"
},
"add_opt_out_language": {
"default": false,
"type": "boolean"
},
"add_org_prefix": {
"default": true,
"example": true,
"type": "boolean"
},
"add_tracking_params": {
"default": false,
"type": "boolean"
},
"additional_filters": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
},
{
"$ref": "#/components/schemas/ProfileHasNotReceivedSmsMessageCondition"
}
]
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"body": {
"type": "string"
},
"custom_tracking_params": {
"items": {
"$ref": "#/components/schemas/UtmParam"
},
"nullable": true,
"type": "array"
},
"dynamic_image": {
"description": "A dynamic image asset to include in the SMS message.",
"example": "{{ person|lookup:'image_url' }}",
"nullable": true,
"type": "string"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"image_id": {
"description": "The id of an ImageAsset. If provided, this will take precedence over a dynamic_image.",
"example": "123",
"nullable": true,
"type": "string"
},
"include_contact_card": {
"default": false,
"type": "boolean"
},
"name": {
"nullable": true,
"type": "string"
},
"shorten_links": {
"default": true,
"example": true,
"type": "boolean"
},
"smart_sending_enabled": {
"default": true,
"example": true,
"type": "boolean"
},
"sms_quiet_hours_enabled": {
"default": true,
"example": true,
"type": "boolean"
},
"template_id": {
"nullable": true,
"type": "string"
},
"transactional": {
"default": false,
"type": "boolean"
}
},
"required": [
"body"
],
"type": "object"
},
"FlowTrackingSettingDynamicParam": {
"properties": {
"type": {
"description": "The type of the tracking parameter",
"enum": [
"dynamic"
],
"type": "string"
},
"value": {
"description": "The value of the tracking parameter",
"enum": [
"email_subject",
"flow_id",
"flow_name",
"link_alt_text",
"message_name",
"message_name_id",
"message_type",
"profile_external_id",
"profile_id"
],
"type": "string"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"FlowTrackingSettingStaticParam": {
"properties": {
"type": {
"description": "The type of the tracking parameter",
"enum": [
"static"
],
"type": "string"
},
"value": {
"description": "The value of the tracking parameter",
"type": "string"
}
},
"required": [
"type",
"value"
],
"type": "object"
},
"FlowUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/FlowUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"FlowUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"status": {
"description": "Status you want to update the flow to. ['draft', 'manual', or 'live']",
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"id": {
"description": "ID of the Flow to update. Ex: XVTP5Q",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"FlowV2ResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"archived": {
"nullable": true,
"type": "boolean"
},
"created": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"trigger_type": {
"description": "Corresponds to the object which triggered the flow.",
"enum": [
"Added to List",
"Date Based",
"Low Inventory",
"Metric",
"Price Drop",
"Unconfigured"
],
"nullable": true,
"type": "string"
},
"updated": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-actions": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"FlowValuesReportEnum": {
"enum": [
"flow-values-report"
],
"type": "string"
},
"FlowValuesRequestDTO": {
"properties": {
"data": {
"$ref": "#/components/schemas/FlowValuesRequestDTOResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"FlowValuesRequestDTOResourceObject": {
"properties": {
"attributes": {
"properties": {
"conversion_metric_id": {
"description": "ID of the metric to be used for conversion statistics",
"example": "RESQ6t",
"type": "string"
},
"filter": {
"description": "API filter string used to filter the query.\nScalar attributes (flow_id, flow_name, send_channel, flow_message_id, flow_message_name, text_message_format, variation, variation_name): Supported operators: equals, contains-any.\nList attributes (tag_id, tag_name): Supported operators: contains-any, contains-all.\nOnly one filter can be used per attribute.\nOnly AND can be used as a combination operator.\nMax of 100 items per list filter.\nWhen filtering on send_channel, allowed values are email, sms, push-notification, whatsapp.",
"example": "and(equals(flow_id,\"abc123\"),contains-any(send_channel,[\"email\",\"sms\"]))",
"nullable": true,
"type": "string"
},
"group_by": {
"description": "List of attributes to group the data by.\nAllowed group-bys are flow_id, flow_message_id, flow_message_name, flow_name, send_channel, tag_id, tag_name, text_message_format, variation, variation_name.\nIf not passed in, the data will be grouped by flow_id, flow_message_id, send_channel.\nThe following group by attributes are required: flow_message_id, flow_id.",
"items": {
"description": "Attributes to represent what is being grouped by for Flows",
"enum": [
"flow_id",
"flow_message_id",
"flow_message_name",
"flow_name",
"send_channel",
"tag_id",
"tag_name",
"text_message_format",
"variation",
"variation_name"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"statistics": {
"description": "List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]",
"example": [
"opens",
"open_rate"
],
"items": {
"description": "Defined reporting metric",
"enum": [
"average_order_value",
"bounce_rate",
"bounced",
"bounced_or_failed",
"bounced_or_failed_rate",
"click_rate",
"click_to_open_rate",
"clicks",
"clicks_unique",
"conversion_rate",
"conversion_uniques",
"conversion_value",
"conversions",
"delivered",
"delivery_rate",
"failed",
"failed_rate",
"message_segment_count_sum",
"open_rate",
"opens",
"opens_unique",
"recipients",
"revenue_per_recipient",
"spam_complaint_rate",
"spam_complaints",
"text_message_credit_usage_amount",
"text_message_roi",
"text_message_spend",
"unsubscribe_rate",
"unsubscribe_uniques",
"unsubscribes"
],
"type": "string"
},
"type": "array"
},
"timeframe": {
"description": "The time frame to pull data from (Max length: 1 year). See [available time frames](https://developers.klaviyo.com/en/reference/reporting_api_overview#available-time-frames).",
"oneOf": [
{
"$ref": "#/components/schemas/Timeframe"
},
{
"$ref": "#/components/schemas/CustomTimeframe"
}
]
}
},
"required": [
"statistics",
"timeframe",
"conversion_metric_id"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowValuesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"FlowWebhook": {
"properties": {
"body": {
"nullable": true,
"type": "string"
},
"headers": {
"nullable": true,
"type": "object"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"url": {
"nullable": true,
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"FlowWhatsApp": {
"properties": {
"add_tracking_params": {
"default": false,
"type": "boolean"
},
"additional_filters": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
}
]
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"smart_sending_enabled": {
"default": true,
"example": true,
"type": "boolean"
},
"transactional": {
"default": false,
"type": "boolean"
},
"vendor_id": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"FlowsProfileMetricCondition": {
"properties": {
"measurement": {
"description": "Measurements for profile metrics.",
"enum": [
"count",
"sum"
],
"type": "string"
},
"measurement_filter": {
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
"metric_filters": {
"items": {
"$ref": "#/components/schemas/ProfileMetricPropertyFilter"
},
"nullable": true,
"type": "array"
},
"metric_id": {
"type": "string"
},
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/AlltimeDateFilter"
},
{
"$ref": "#/components/schemas/SinceFlowStartDateFilter"
}
]
},
"type": {
"enum": [
"profile-metric"
],
"type": "string"
}
},
"required": [
"type",
"metric_id",
"measurement",
"measurement_filter",
"timeframe_filter"
],
"type": "object"
},
"FormCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/FormCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"FormCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"ab_test": {
"description": "Whether the form has an A/B test configured.",
"type": "boolean"
},
"definition": {
"$ref": "#/components/schemas/FormDefinition",
"description": "The encoded form definition."
},
"name": {
"description": "The name of the form.",
"example": "Cyber Monday Deals",
"type": "string"
},
"status": {
"description": "The status of the form.",
"enum": [
"draft"
],
"example": "draft",
"type": "string"
}
},
"required": [
"definition",
"status",
"ab_test",
"name"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FormEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"FormDefinition": {
"properties": {
"versions": {
"items": {
"$ref": "#/components/schemas/Version"
},
"type": "array"
}
},
"required": [
"versions"
],
"type": "object"
},
"FormEnum": {
"enum": [
"form"
],
"type": "string"
},
"FormMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/InStringArrayFilter",
"description": "Optional filter on a specific list of form ids",
"nullable": true
},
"method": {
"enum": [
"form"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"FormResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"ab_test": {
"description": "Whether the form has an A/B test configured, regardless of its status.",
"type": "boolean"
},
"created_at": {
"description": "ISO8601 timestamp when the form was created.",
"example": "2024-03-04T00:00:00Z",
"format": "date-time",
"type": "string"
},
"name": {
"description": "Name of the form.",
"example": "Cyber Monday Deals",
"type": "string"
},
"status": {
"description": "Status of the form. A live form with an in-progress draft is considered \"live\".",
"enum": [
"draft",
"live"
],
"type": "string"
},
"updated_at": {
"description": "ISO8601 timestamp when the form was last updated.",
"example": "2024-03-04T00:00:00Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"status",
"ab_test",
"created_at",
"updated_at"
],
"type": "object"
},
"id": {
"description": "ID of the form. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"form-versions": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FormVersionEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FormEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"FormSeriesReportEnum": {
"enum": [
"form-series-report"
],
"type": "string"
},
"FormSeriesRequestDTO": {
"properties": {
"data": {
"$ref": "#/components/schemas/FormSeriesRequestDTOResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"FormSeriesRequestDTOResourceObject": {
"properties": {
"attributes": {
"properties": {
"filter": {
"description": "API filter string used to filter the query.\nAllowed filters are form_id, form_version_id.\nAllowed operators are equals, any.\nOnly one filter can be used per attribute, only AND can be used as a combination operator.\nMax of 100 messages per ANY filter.",
"example": "and(equals(form_id,\"abc123\"),any(form_version_id,[\"xyz123\",\"ghi456\"]))",
"nullable": true,
"type": "string"
},
"group_by": {
"description": "List of attributes to group the data by.\nAllowed group-bys are form_id, form_version_id.\nIf not passed in, the data will be grouped by form_id.\nIf a group by has prerequisites, they must be passed in together. The prerequisites for form_version_id is form_id",
"items": {
"description": "Attributes to represent what is being grouped by for Forms",
"enum": [
"form_id",
"form_version_id"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"interval": {
"description": "The interval used to aggregate data within the series request.\nIf hourly is used, the timeframe cannot be longer than 7 days.\nIf daily is used, the timeframe cannot be longer than 60 days.\nIf monthly is used, the timeframe cannot be longer than 52 weeks.",
"enum": [
"daily",
"hourly",
"monthly",
"weekly"
],
"example": "weekly",
"type": "string"
},
"statistics": {
"description": "List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]",
"example": [
"viewed_form",
"submit_rate"
],
"items": {
"description": "Defined form reporting metric",
"enum": [
"closed_form",
"closed_form_uniques",
"qualified_form",
"qualified_form_uniques",
"submit_rate",
"submits",
"submitted_form_step",
"submitted_form_step_uniques",
"viewed_form",
"viewed_form_step",
"viewed_form_step_uniques",
"viewed_form_uniques"
],
"type": "string"
},
"type": "array"
},
"timeframe": {
"description": "The time frame to pull data from (Max length: 1 year). See [available time frames](https://developers.klaviyo.com/en/reference/reporting_api_overview#available-time-frames).",
"oneOf": [
{
"$ref": "#/components/schemas/Timeframe"
},
{
"$ref": "#/components/schemas/CustomTimeframe"
}
]
}
},
"required": [
"statistics",
"timeframe",
"interval"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FormSeriesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"FormSubscribeFilter": {
"properties": {
"field": {
"enum": [
"subscribe_method"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/InStringArrayFilter",
"description": "Optional filter on a specific list of form IDs",
"nullable": true
},
"method": {
"enum": [
"form"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"FormValuesReportEnum": {
"enum": [
"form-values-report"
],
"type": "string"
},
"FormValuesRequestDTO": {
"properties": {
"data": {
"$ref": "#/components/schemas/FormValuesRequestDTOResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"FormValuesRequestDTOResourceObject": {
"properties": {
"attributes": {
"properties": {
"filter": {
"description": "API filter string used to filter the query.\nAllowed filters are form_id, form_version_id.\nAllowed operators are equals, any.\nOnly one filter can be used per attribute, only AND can be used as a combination operator.\nMax of 100 messages per ANY filter.",
"example": "and(equals(form_id,\"abc123\"),any(form_version_id,[\"xyz123\",\"ghi456\"]))",
"nullable": true,
"type": "string"
},
"group_by": {
"description": "List of attributes to group the data by.\nAllowed group-bys are form_id, form_version_id.\nIf not passed in, the data will be grouped by form_id.\nIf a group by has prerequisites, they must be passed in together. The prerequisites for form_version_id is form_id",
"items": {
"description": "Attributes to represent what is being grouped by for Forms",
"enum": [
"form_id",
"form_version_id"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"statistics": {
"description": "List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]",
"example": [
"viewed_form",
"submit_rate"
],
"items": {
"description": "Defined form reporting metric",
"enum": [
"closed_form",
"closed_form_uniques",
"qualified_form",
"qualified_form_uniques",
"submit_rate",
"submits",
"submitted_form_step",
"submitted_form_step_uniques",
"viewed_form",
"viewed_form_step",
"viewed_form_step_uniques",
"viewed_form_uniques"
],
"type": "string"
},
"type": "array"
},
"timeframe": {
"description": "The time frame to pull data from (Max length: 1 year). See [available time frames](https://developers.klaviyo.com/en/reference/reporting_api_overview#available-time-frames).",
"oneOf": [
{
"$ref": "#/components/schemas/Timeframe"
},
{
"$ref": "#/components/schemas/CustomTimeframe"
}
]
}
},
"required": [
"statistics",
"timeframe"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FormValuesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"FormVersionABTest": {
"properties": {
"variation_name": {
"description": "This is the name of the AB test variation.",
"type": "string"
}
},
"required": [
"variation_name"
],
"type": "object"
},
"FormVersionEnum": {
"enum": [
"form-version"
],
"type": "string"
},
"FormVersionResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"ab_test": {
"$ref": "#/components/schemas/FormVersionABTest",
"nullable": true
},
"created_at": {
"description": "ISO8601 timestamp when the form version was created.",
"example": "2024-03-04T00:00:00Z",
"format": "date-time",
"type": "string"
},
"form_type": {
"description": "The type of form.",
"enum": [
"banner",
"embed",
"flyout",
"full_page",
"popup"
],
"type": "string"
},
"status": {
"description": "Status of the form version. \"live\" means it's live on site.",
"enum": [
"draft",
"live"
],
"type": "string"
},
"updated_at": {
"description": "ISO8601 timestamp when the form version was last updated.",
"example": "2024-03-04T00:00:00Z",
"format": "date-time",
"type": "string"
},
"variation_name": {
"description": "The name of the form version.",
"type": "string"
}
},
"required": [
"form_type",
"variation_name",
"status",
"created_at",
"updated_at"
],
"type": "object"
},
"id": {
"description": "ID of the form version. Generated by Klaviyo.",
"example": "1234567",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"form": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FormEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FormVersionEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"GeofenceEnum": {
"enum": [
"geofence"
],
"type": "string"
},
"GeofenceResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"latitude": {
"description": "Latitude coordinate of the geofence center point",
"example": 40.7128,
"type": "number"
},
"longitude": {
"description": "Longitude coordinate of the geofence center point",
"example": -74.006,
"type": "number"
},
"radius": {
"description": "Radius in meters from the center point",
"example": 100,
"type": "number"
}
},
"required": [
"latitude",
"longitude",
"radius"
],
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this geofence. Generated by the system.",
"example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/GeofenceEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"GetAccountResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/AccountResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetAccountResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AccountResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetBulkProfileSuppressionsCreateJobResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/BulkProfileSuppressionsCreateJobResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetBulkProfileSuppressionsCreateJobResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/BulkProfileSuppressionsCreateJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetBulkProfileSuppressionsRemoveJobResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/BulkProfileSuppressionsRemoveJobResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetBulkProfileSuppressionsRemoveJobResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/BulkProfileSuppressionsRemoveJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignMessageCampaignRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "The campaign ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignMessageImageRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "The ID of the image",
"example": "7",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignMessageResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CampaignMessageResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateResponseObjectResource"
},
{
"$ref": "#/components/schemas/CampaignResponseObjectResource"
},
{
"$ref": "#/components/schemas/ImageResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignMessageResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignMessageResponseObjectResource"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TemplateResponseObjectResource"
},
{
"$ref": "#/components/schemas/CampaignResponseObjectResource"
},
{
"$ref": "#/components/schemas/ImageResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignMessageTemplateRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "The ID of template",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignMessagesRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The message ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignRecipientEstimationJobResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignRecipientEstimationJobResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignRecipientEstimationResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignRecipientEstimationResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignResponse": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CampaignResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CampaignResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TagResponseObjectResource"
},
{
"$ref": "#/components/schemas/CampaignMessageResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignResponseObjectResource"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TagResponseObjectResource"
},
{
"$ref": "#/components/schemas/CampaignMessageResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignSendJobResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/CampaignSendJobResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCampaignTagsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogCategoryCreateJobResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogCategoryCreateJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogCategoryCreateJobResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogCategoryCreateJobResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/CatalogCategoryResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogCategoryDeleteJobResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogCategoryDeleteJobResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogCategoryDeleteJobResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogCategoryDeleteJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogCategoryItemsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogCategoryResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogCategoryResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogCategoryResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogCategoryResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogCategoryUpdateJobResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogCategoryUpdateJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogCategoryUpdateJobResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogCategoryUpdateJobResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/CatalogCategoryResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogItemCategoriesRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogItemCreateJobResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogItemCreateJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogItemCreateJobResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogItemCreateJobResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/CatalogItemResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogItemDeleteJobResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogItemDeleteJobResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogItemDeleteJobResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogItemDeleteJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogItemResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogItemResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogItemResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogItemResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogItemUpdateJobResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogItemUpdateJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogItemUpdateJobResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogItemUpdateJobResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/CatalogItemResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogItemVariantsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogVariantCreateJobResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogVariantCreateJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogVariantCreateJobResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogVariantCreateJobResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogVariantDeleteJobResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogVariantDeleteJobResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogVariantDeleteJobResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogVariantDeleteJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogVariantResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogVariantResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogVariantUpdateJobResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CatalogVariantUpdateJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCatalogVariantUpdateJobResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CatalogVariantUpdateJobResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/CatalogVariantResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetClientReviewResponseDTOCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ClientReviewResponseDTOObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetConversationResponse": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/ConversationResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCouponCodeCouponRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"example": "10OFF",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CouponEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCouponCodeCreateJobResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CouponCodeCreateJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCouponCodeCreateJobResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CouponCodeCreateJobResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/CouponCodeResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCouponCodeResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CouponCodeResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCouponCodeResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CouponCodeResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"$ref": "#/components/schemas/CouponResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCouponCodeResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CouponCodeResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/CouponResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCouponCodesRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CouponCodeEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCouponResponse": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CouponResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCouponResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CouponResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCustomMetricMetricsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The Metric ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCustomMetricResponse": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/CustomMetricResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCustomMetricResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CustomMetricResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"$ref": "#/components/schemas/MetricResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetCustomMetricResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/CustomMetricResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/MetricResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetDataSourceResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/DataSourceResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetDataSourceResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DataSourceResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetEncodedFormResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/EncodedFormResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetEventMetricRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "The Metric ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetEventProfileRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetEventResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EventResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MetricResponseObjectResource"
},
{
"$ref": "#/components/schemas/ProfileResponseObjectResource"
},
{
"$ref": "#/components/schemas/AttributionResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetEventResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/EventResponseObjectResource"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MetricResponseObjectResource"
},
{
"$ref": "#/components/schemas/ProfileResponseObjectResource"
},
{
"$ref": "#/components/schemas/AttributionResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowActionEncodedResponse": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/FlowActionEncodedResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowActionEncodedResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/FlowActionEncodedResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowActionEncodedResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/FlowActionEncodedResponseObjectResource"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/FlowResponseObjectResource"
},
{
"$ref": "#/components/schemas/FlowMessageEncodedResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowActionFlowMessageRelationshipResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowActionFlowRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowFlowActionRelationshipListResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowMessageActionRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowMessageEncodedResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/FlowMessageEncodedResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowMessageEncodedResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/FlowMessageEncodedResponseObjectResource"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/FlowActionEncodedResponseObjectResource"
},
{
"$ref": "#/components/schemas/TemplateResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowMessageTemplateRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "The ID of template",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowResponse": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/FlowResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/FlowResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/FlowResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/FlowActionEncodedResponseObjectResource"
},
{
"$ref": "#/components/schemas/TagResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowTagsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFlowV2ResponseCompoundDocument": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"definition": {
"$ref": "#/components/schemas/FlowDefinition",
"description": "The encoded flow definition. Unsupported objects (triggers, actions, etc.) will be included but labeled as unsupported.",
"nullable": true
}
}
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
}
},
{
"$ref": "#/components/schemas/FlowV2ResponseObjectResource"
}
]
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/FlowActionEncodedResponseObjectResource"
},
{
"$ref": "#/components/schemas/TagResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFormResponse": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/FormResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFormResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/FormResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFormVersionFormRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "ID of the form. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FormEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFormVersionResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/FormVersionResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFormVersionResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/FormVersionResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/FormResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetFormVersionsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "ID of the form version. Generated by Klaviyo.",
"example": "1234567",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FormVersionEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetGeofenceResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/GeofenceResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetImageResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/ImageResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetImageResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ImageResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetImportErrorResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ImportErrorResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetListFlowTriggersRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetListListResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ListListResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TagResponseObjectResource"
},
{
"$ref": "#/components/schemas/FlowResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetListMemberResponseCollection": {
"properties": {
"data": {
"items": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"predictive_analytics": {
"$ref": "#/components/schemas/PredictiveAnalytics",
"nullable": true
},
"subscriptions": {
"$ref": "#/components/schemas/Subscriptions",
"nullable": true
}
}
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
}
},
{
"$ref": "#/components/schemas/ListMemberResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetListProfilesRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetListResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ListResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetListRetrieveResponseCompoundDocument": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"profile_count": {
"nullable": true,
"type": "integer"
}
}
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
}
},
{
"$ref": "#/components/schemas/ListRetrieveResponseObjectResource"
}
]
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TagResponseObjectResource"
},
{
"$ref": "#/components/schemas/FlowResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetListTagsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMappedMetricCustomMetricRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "The ID of the custom metric",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CustomMetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMappedMetricMetricRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "The Metric ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMappedMetricResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/MappedMetricResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MetricResponseObjectResource"
},
{
"$ref": "#/components/schemas/CustomMetricResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMappedMetricResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/MappedMetricResponseObjectResource"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MetricResponseObjectResource"
},
{
"$ref": "#/components/schemas/CustomMetricResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMetricFlowTriggersRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMetricPropertiesRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The ID of the metric property",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricPropertyEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMetricPropertyMetricRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "The Metric ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMetricPropertyResponseCollection": {
"properties": {
"data": {
"items": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"sample_values": {
"items": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"nullable": true,
"type": "array"
}
}
},
"type": {
"$ref": "#/components/schemas/MetricPropertyEnum"
}
}
},
{
"$ref": "#/components/schemas/MetricPropertyResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMetricPropertyResponseCompoundDocument": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"sample_values": {
"items": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"nullable": true,
"type": "array"
}
}
},
"type": {
"$ref": "#/components/schemas/MetricPropertyEnum"
}
}
},
{
"$ref": "#/components/schemas/MetricPropertyResponseObjectResource"
}
]
},
"included": {
"items": {
"$ref": "#/components/schemas/MetricResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMetricResponse": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/MetricResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMetricResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/MetricResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMetricResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/MetricResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"$ref": "#/components/schemas/FlowResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetMetricResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/MetricResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/FlowResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileBulkImportJobListsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileBulkImportJobProfilesRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileConversationRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ConversationEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileImportJobResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProfileImportJobResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileImportJobResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileImportJobResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/ListResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileListsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfilePushTokensRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "ID of push token",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/PushTokenEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileResponse": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"predictive_analytics": {
"$ref": "#/components/schemas/PredictiveAnalytics",
"nullable": true
},
"subscriptions": {
"$ref": "#/components/schemas/Subscriptions",
"nullable": true
}
}
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
}
},
{
"$ref": "#/components/schemas/ProfileResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileResponseCollection": {
"properties": {
"data": {
"items": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"predictive_analytics": {
"$ref": "#/components/schemas/PredictiveAnalytics",
"nullable": true
},
"subscriptions": {
"$ref": "#/components/schemas/Subscriptions",
"nullable": true
}
}
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
}
},
{
"$ref": "#/components/schemas/ProfileResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"predictive_analytics": {
"$ref": "#/components/schemas/PredictiveAnalytics",
"nullable": true
},
"subscriptions": {
"$ref": "#/components/schemas/Subscriptions",
"nullable": true
}
}
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
}
},
{
"$ref": "#/components/schemas/ProfileResponseObjectResource"
}
]
},
"type": "array"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversationResponseObjectResource"
},
{
"$ref": "#/components/schemas/PushTokenResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileResponseCompoundDocument": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"predictive_analytics": {
"$ref": "#/components/schemas/PredictiveAnalytics",
"nullable": true
},
"subscriptions": {
"$ref": "#/components/schemas/Subscriptions",
"nullable": true
}
}
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
}
},
{
"$ref": "#/components/schemas/ProfileResponseObjectResource"
}
]
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ListResponseObjectResource"
},
{
"$ref": "#/components/schemas/SegmentResponseObjectResource"
},
{
"$ref": "#/components/schemas/ConversationResponseObjectResource"
},
{
"$ref": "#/components/schemas/PushTokenResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetProfileSegmentsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetPushTokenProfileRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetPushTokenResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/PushTokenResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetPushTokenResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/PushTokenResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"$ref": "#/components/schemas/ProfileResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetPushTokenResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/PushTokenResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/ProfileResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetReviewResponseDTOCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ReviewResponseDTOObjectResource"
},
"type": "array"
},
"included": {
"items": {
"$ref": "#/components/schemas/EventResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetReviewResponseDTOCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/ReviewResponseDTOObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/EventResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetReviewValuesReportResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ReviewValuesReportResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetSegmentFlowTriggersRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetSegmentListResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/SegmentListResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TagResponseObjectResource"
},
{
"$ref": "#/components/schemas/FlowResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetSegmentMemberResponseCollection": {
"properties": {
"data": {
"items": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"predictive_analytics": {
"$ref": "#/components/schemas/PredictiveAnalytics",
"nullable": true
},
"subscriptions": {
"$ref": "#/components/schemas/Subscriptions",
"nullable": true
}
}
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
}
},
{
"$ref": "#/components/schemas/SegmentMemberResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetSegmentProfilesRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetSegmentResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/SegmentResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetSegmentRetrieveResponseCompoundDocument": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"profile_count": {
"nullable": true,
"type": "integer"
}
}
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
}
},
{
"$ref": "#/components/schemas/SegmentRetrieveResponseObjectResource"
}
]
},
"included": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TagResponseObjectResource"
},
{
"$ref": "#/components/schemas/FlowResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetSegmentTagsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagCampaignRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The IDs of all campaigns that are associated with the Tag",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagFlowRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The IDs of all flows that are associated with the Tag",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagGroupRelationshipResponse": {
"properties": {
"data": {
"nullable": true,
"properties": {
"id": {
"description": "The Tag Group ID",
"example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagGroupEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagGroupResponse": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/TagGroupResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagGroupResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/TagGroupResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagGroupTagsRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagListRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The IDs of all lists that are associated with the Tag",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/TagResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/TagResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"$ref": "#/components/schemas/TagGroupResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/TagResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/TagGroupResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTagSegmentRelationshipsResponseCollection": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The IDs of all segments that are associated with the Tag",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTemplateDndResponse": {
"properties": {
"data": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"definition": {
"$ref": "#/components/schemas/TemplateDefinition",
"description": "Template definition for SYSTEM_DRAGGABLE templates. Omitted for CODE/USER_DRAGGABLE. Use additional-fields[template]=definition to include in list responses.",
"nullable": true
}
}
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
}
},
{
"$ref": "#/components/schemas/TemplateDndResponseObjectResource"
}
]
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTemplateDndResponseCollection": {
"properties": {
"data": {
"items": {
"allOf": [
{
"properties": {
"attributes": {
"properties": {
"definition": {
"$ref": "#/components/schemas/TemplateDefinition",
"description": "Template definition for SYSTEM_DRAGGABLE templates. Omitted for CODE/USER_DRAGGABLE. Use additional-fields[template]=definition to include in list responses.",
"nullable": true
}
}
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
}
},
{
"$ref": "#/components/schemas/TemplateDndResponseObjectResource"
}
]
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTemplateResponse": {
"properties": {
"data": {
"allOf": [
{
"$ref": "#/components/schemas/TemplateResponseObjectResource"
}
],
"nullable": true
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTrackingSettingResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/TrackingSettingResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetTrackingSettingResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/TrackingSettingResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetUniversalContentResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/UniversalContentResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetUniversalContentResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/UniversalContentResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetWebFeedResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/WebFeedResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetWebFeedResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/WebFeedResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetWebhookResponseCollectionCompoundDocument": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/WebhookResponseObjectResource"
},
"type": "array"
},
"included": {
"items": {
"$ref": "#/components/schemas/WebhookTopicResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetWebhookResponseCompoundDocument": {
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookResponseObjectResource"
},
"included": {
"items": {
"$ref": "#/components/schemas/WebhookTopicResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetWebhookTopicResponse": {
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookTopicResponseObjectResource"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GetWebhookTopicResponseCollection": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/WebhookTopicResponseObjectResource"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/CollectionLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"GoToInbox": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"enum": [
null
]
},
"submit": {
"default": true,
"enum": [
true
],
"example": true,
"type": "boolean"
},
"type": {
"enum": [
"go_to_inbox"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"GreaterThanPositiveNumericFilter": {
"properties": {
"operator": {
"enum": [
"greater-than"
],
"type": "string"
},
"type": {
"enum": [
"numeric"
],
"type": "string"
},
"value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"GroupingCompany": {
"properties": {
"company_id": {
"description": "The ID of the company",
"example": "67890",
"type": "string"
}
},
"required": [
"company_id"
],
"type": "object"
},
"GroupingProduct": {
"properties": {
"product_id": {
"description": "The ID of the product",
"example": "12345",
"type": "string"
}
},
"required": [
"product_id"
],
"type": "object"
},
"HTMLBlockDataV0": {
"properties": {
"content": {
"type": "string"
},
"display_options": {
"$ref": "#/components/schemas/BlockDisplayOptions"
}
},
"required": [
"content",
"display_options"
],
"type": "object"
},
"HTMLBlockDataV1": {
"properties": {
"content": {
"type": "string"
},
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
}
},
"required": [
"content",
"display_options"
],
"type": "object"
},
"HTMLBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/HTMLBlockDataV0"
},
"type": {
"enum": [
"html"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"HTMLBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/HTMLBlockDataV1"
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"html"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"HTMLText": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/HTMLTextProperties"
},
"styles": {
"$ref": "#/components/schemas/HTMLTextStyles"
},
"type": {
"enum": [
"html_text"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"HTMLTextProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"content": {
"default": "",
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"HTMLTextStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"HasEmailMarketing": {
"properties": {
"filters": {
"nullable": true
},
"subscription": {
"enum": [
"any"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"HasEmailMarketingConsent": {
"properties": {
"can_receive_marketing": {
"enum": [
true
],
"type": "boolean"
},
"channel": {
"enum": [
"email"
],
"type": "string"
},
"consent_status": {
"oneOf": [
{
"$ref": "#/components/schemas/HasEmailMarketing"
},
{
"$ref": "#/components/schemas/HasEmailMarketingSubscribed"
},
{
"$ref": "#/components/schemas/HasEmailMarketingNeverSubscribed"
}
]
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
],
"type": "object"
},
"HasEmailMarketingNeverSubscribed": {
"properties": {
"filters": {
"nullable": true
},
"subscription": {
"enum": [
"never_subscribed"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"HasEmailMarketingSubscribed": {
"properties": {
"filters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/DoubleOptinFilter"
},
{
"$ref": "#/components/schemas/StatusDateFilter"
},
{
"$ref": "#/components/schemas/CustomSourceFilter"
},
{
"$ref": "#/components/schemas/FormMethodFilter"
},
{
"$ref": "#/components/schemas/PreferencePageFilter"
},
{
"$ref": "#/components/schemas/APIMethodFilter"
},
{
"$ref": "#/components/schemas/InboundMessageMethodFilter"
},
{
"$ref": "#/components/schemas/BackInStockMethodFilter"
},
{
"$ref": "#/components/schemas/SftpMethodFilter"
},
{
"$ref": "#/components/schemas/ManualImportManualMethodFilter"
},
{
"$ref": "#/components/schemas/ManualAddManualMethodFilter"
},
{
"$ref": "#/components/schemas/ShopifyIntegrationMethodFilter"
}
]
},
"nullable": true,
"type": "array"
},
"subscription": {
"enum": [
"subscribed"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"HasPushMarketing": {
"properties": {
"filters": {
"items": {
"$ref": "#/components/schemas/StatusDateFilter"
},
"nullable": true,
"type": "array"
},
"subscription": {
"enum": [
"any"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"HasPushMarketingConsent": {
"properties": {
"can_receive_marketing": {
"enum": [
true
],
"type": "boolean"
},
"channel": {
"enum": [
"push"
],
"type": "string"
},
"consent_status": {
"$ref": "#/components/schemas/HasPushMarketing"
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
],
"type": "object"
},
"HasSMSMarketingConsent": {
"properties": {
"can_receive_marketing": {
"enum": [
true
],
"type": "boolean"
},
"channel": {
"enum": [
"sms"
],
"type": "string"
},
"consent_status": {
"$ref": "#/components/schemas/HasSMSMarketingSubscribed"
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
],
"type": "object"
},
"HasSMSMarketingSubscribed": {
"properties": {
"filters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/StatusDateFilter"
},
{
"$ref": "#/components/schemas/FormMethodFilter"
},
{
"$ref": "#/components/schemas/ManualImportManualMethodFilter"
},
{
"$ref": "#/components/schemas/ManualAddManualMethodFilter"
},
{
"$ref": "#/components/schemas/CheckoutMethodFilter"
},
{
"$ref": "#/components/schemas/InboundMessageMethodFilter"
},
{
"$ref": "#/components/schemas/PreferencePageMethodFilter"
},
{
"$ref": "#/components/schemas/SftpMethodFilter"
},
{
"$ref": "#/components/schemas/ShopifyIntegrationMethodFilter"
},
{
"$ref": "#/components/schemas/SubscribedSMSIsRcsCapableFilter"
}
]
},
"nullable": true,
"type": "array"
},
"subscription": {
"enum": [
"subscribed"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"HeaderBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"styles": {
"$ref": "#/components/schemas/HeaderBlockStyles"
}
},
"required": [
"display_options",
"styles"
],
"type": "object"
},
"HeaderBlockStyles": {
"properties": {
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"border_color": {
"nullable": true,
"type": "string"
},
"border_radius": {
"nullable": true,
"type": "integer"
},
"border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"border_width": {
"nullable": true,
"type": "integer"
},
"color": {
"nullable": true,
"type": "string"
},
"desktop_layout": {
"description": "Header block desktop layout.",
"enum": [
"centered",
"inline",
"links",
"stacked"
],
"nullable": true,
"type": "string"
},
"font_family": {
"nullable": true,
"type": "string"
},
"font_size": {
"nullable": true,
"type": "integer"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"inner_padding_bottom": {
"nullable": true,
"type": "integer"
},
"inner_padding_left": {
"nullable": true,
"type": "integer"
},
"inner_padding_right": {
"nullable": true,
"type": "integer"
},
"inner_padding_top": {
"nullable": true,
"type": "integer"
},
"item_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"item_spacing": {
"nullable": true,
"type": "integer"
},
"item_spacing_type": {
"description": "Header block item spacing type.",
"enum": [
"auto",
"manual"
],
"nullable": true,
"type": "string"
},
"letter_spacing": {
"nullable": true,
"type": "integer"
},
"logo_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"logo_link_spacing": {
"nullable": true,
"type": "integer"
},
"mobile_layout": {
"description": "Header block mobile layout.",
"enum": [
"inline",
"links",
"links-stacked",
"logo-stacked",
"stacked"
],
"nullable": true,
"type": "string"
},
"mobile_spacing": {
"nullable": true,
"type": "integer"
},
"mobile_wrap": {
"nullable": true,
"type": "boolean"
},
"text_decoration": {
"nullable": true,
"type": "string"
},
"vertical_align": {
"description": "Vertical alignment.",
"enum": [
"baseline",
"bottom",
"middle",
"top"
],
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"HeaderBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"type": {
"enum": [
"header"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"HeaderBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/HeaderBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"subblocks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/HeaderLinkSubBlock"
},
{
"$ref": "#/components/schemas/HeaderImageSubBlock"
},
{
"$ref": "#/components/schemas/HeaderLogoSubBlock"
}
]
},
"nullable": true,
"type": "array"
},
"type": {
"enum": [
"header"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"HeaderImageSubBlock": {
"properties": {
"alt_text": {
"nullable": true,
"type": "string"
},
"asset_id": {
"nullable": true,
"type": "string"
},
"background_color": {
"nullable": true,
"type": "string"
},
"height": {
"nullable": true,
"type": "integer"
},
"href": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"max_width": {
"nullable": true,
"type": "integer"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"src": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"header_link_bar_image"
],
"type": "string"
},
"width": {
"nullable": true,
"type": "integer"
}
},
"required": [
"type"
],
"type": "object"
},
"HeaderLinkSubBlock": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"content": {
"nullable": true,
"type": "string"
},
"drop_shadow_color": {
"nullable": true,
"type": "string"
},
"href": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"header_link_bar_button"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"HeaderLogoSubBlock": {
"properties": {
"alt_text": {
"nullable": true,
"type": "string"
},
"asset_id": {
"nullable": true,
"type": "string"
},
"height": {
"nullable": true,
"type": "integer"
},
"href": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"max_width": {
"nullable": true,
"type": "integer"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"src": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"header_link_bar_logo"
],
"type": "string"
},
"width": {
"nullable": true,
"type": "integer"
}
},
"required": [
"type"
],
"type": "object"
},
"Heading1Style": {
"properties": {
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"style_type": {
"enum": [
"heading-1-styles"
],
"type": "string"
},
"styles": {
"$ref": "#/components/schemas/HeadingStyleStyles"
}
},
"required": [
"style_type",
"styles"
],
"type": "object"
},
"Heading2Style": {
"properties": {
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"style_type": {
"enum": [
"heading-2-styles"
],
"type": "string"
},
"styles": {
"$ref": "#/components/schemas/HeadingStyleStyles"
}
},
"required": [
"style_type",
"styles"
],
"type": "object"
},
"Heading3Style": {
"properties": {
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"style_type": {
"enum": [
"heading-3-styles"
],
"type": "string"
},
"styles": {
"$ref": "#/components/schemas/HeadingStyleStyles"
}
},
"required": [
"style_type",
"styles"
],
"type": "object"
},
"Heading4Style": {
"properties": {
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"style_type": {
"enum": [
"heading-4-styles"
],
"type": "string"
},
"styles": {
"$ref": "#/components/schemas/HeadingStyleStyles"
}
},
"required": [
"style_type",
"styles"
],
"type": "object"
},
"HeadingStyleStyles": {
"properties": {
"color": {
"nullable": true,
"type": "string"
},
"font_family": {
"nullable": true,
"type": "string"
},
"font_size": {
"nullable": true,
"type": "integer"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"letter_spacing": {
"nullable": true,
"type": "integer"
},
"line_height": {
"nullable": true,
"type": "number"
},
"margin_bottom": {
"nullable": true,
"type": "integer"
},
"mobile_font_size": {
"nullable": true,
"type": "integer"
},
"mobile_line_height": {
"nullable": true,
"type": "number"
},
"text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"HorizontalRuleBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"styles": {
"$ref": "#/components/schemas/HorizontalRuleBlockStyles"
}
},
"required": [
"display_options",
"styles"
],
"type": "object"
},
"HorizontalRuleBlockStyles": {
"properties": {
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"border_color": {
"nullable": true,
"type": "string"
},
"border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"border_width": {
"nullable": true,
"type": "integer"
},
"mobile_stretch_content": {
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"HorizontalRuleBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true
},
"type": {
"enum": [
"horizontal_rule"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"HorizontalRuleBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/HorizontalRuleBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"horizontal_rule"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"IafDeeplinkToScreen": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/IafDeeplinkToScreenProperties"
},
"submit": {
"default": true,
"enum": [
true
],
"example": true,
"type": "boolean"
},
"type": {
"enum": [
"iaf_deeplink_to_screen"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"IafDeeplinkToScreenProperties": {
"properties": {
"deep_link_url": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"IdentifiedProfiles": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/TriggerBaseProperties"
},
"type": {
"enum": [
"identified_profiles"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Image": {
"properties": {
"action": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/Close"
},
{
"$ref": "#/components/schemas/NextStep"
},
{
"$ref": "#/components/schemas/OpenForm"
},
{
"$ref": "#/components/schemas/PromotionalSMSSubscription"
},
{
"$ref": "#/components/schemas/Redirect"
},
{
"$ref": "#/components/schemas/ResendOptInCode"
},
{
"$ref": "#/components/schemas/SubmitOptInCode"
},
{
"$ref": "#/components/schemas/SubscribeViaSMS"
},
{
"$ref": "#/components/schemas/SubscribeViaWhatsApp"
},
{
"$ref": "#/components/schemas/GoToInbox"
},
{
"$ref": "#/components/schemas/SubmitBackInStock"
},
{
"$ref": "#/components/schemas/SkipToSuccess"
},
{
"$ref": "#/components/schemas/IafDeeplinkToScreen"
}
]
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/ImageProperties"
},
"styles": {
"$ref": "#/components/schemas/ImageStyles"
},
"type": {
"enum": [
"image"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"ImageAssetProperties": {
"properties": {
"alt_text": {
"nullable": true,
"type": "string"
},
"asset_id": {
"nullable": true,
"type": "integer"
},
"id": {
"nullable": true,
"type": "integer"
},
"original_image_url": {
"nullable": true,
"type": "string"
},
"src": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ImageBlockCroppingProperties": {
"properties": {
"aspect_ratio": {
"nullable": true,
"type": "string"
},
"asset_id": {
"nullable": true,
"type": "string"
},
"height": {
"nullable": true,
"type": "integer"
},
"src": {
"nullable": true,
"type": "string"
},
"width": {
"nullable": true,
"type": "integer"
},
"x": {
"nullable": true,
"type": "integer"
},
"y": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"ImageBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"properties": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticImageBlockProperties"
},
{
"$ref": "#/components/schemas/DynamicImageBlockProperties"
}
]
},
"styles": {
"$ref": "#/components/schemas/ImageBlockStyles"
}
},
"required": [
"properties",
"display_options",
"styles"
],
"type": "object"
},
"ImageBlockStyles": {
"properties": {
"align": {
"description": "Image Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"background_color": {
"nullable": true,
"type": "string"
},
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_border_color": {
"nullable": true,
"type": "string"
},
"block_border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"block_border_width": {
"nullable": true,
"type": "integer"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"full_width_mobile": {
"nullable": true,
"type": "boolean"
},
"height": {
"nullable": true,
"type": "integer"
},
"inner_padding_bottom": {
"nullable": true,
"type": "integer"
},
"inner_padding_left": {
"nullable": true,
"type": "integer"
},
"inner_padding_right": {
"nullable": true,
"type": "integer"
},
"inner_padding_top": {
"nullable": true,
"type": "integer"
},
"max_width": {
"nullable": true,
"type": "integer"
},
"mobile_stretch_content": {
"nullable": true,
"type": "boolean"
},
"width": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"ImageBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true
},
"type": {
"enum": [
"image"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"ImageBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/ImageBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"image"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"ImageCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ImageCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ImageCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"hidden": {
"default": false,
"description": "If true, this image is not shown in the asset library.",
"nullable": true,
"type": "boolean"
},
"import_from_url": {
"description": "An existing image url to import the image from. Alternatively, you may specify a base-64 encoded data-uri (`data:image/...`). Supported image formats: jpeg,png,gif. Maximum image size: 5MB.",
"example": "https://www.example.com/example.jpg",
"type": "string"
},
"name": {
"description": "A name for the image. Defaults to the filename if not provided. If the name matches an existing image, a suffix will be added.",
"nullable": true,
"type": "string"
}
},
"required": [
"import_from_url"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ImageDropShadowStyles": {
"properties": {
"blur": {
"default": 15,
"example": 15,
"type": "integer"
},
"color": {
"default": "#000000",
"example": "#000000",
"type": "string"
},
"enabled": {
"default": false,
"type": "boolean"
},
"x_offset": {
"default": 0,
"type": "integer"
},
"y_offset": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"ImageEnum": {
"enum": [
"image"
],
"type": "string"
},
"ImagePartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ImagePartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ImagePartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"hidden": {
"description": "If true, this image is not shown in the asset library.",
"nullable": true,
"type": "boolean"
},
"name": {
"description": "A name for the image.",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The ID of the image",
"example": "7",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"ImageProperties": {
"properties": {
"additional_fields": {
"items": {
"$ref": "#/components/schemas/AdditionalField"
},
"nullable": true,
"type": "array"
},
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"image": {
"$ref": "#/components/schemas/ImageAssetProperties",
"nullable": true
}
},
"required": [
"image"
],
"type": "object"
},
"ImageResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"format": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"image_url": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
},
"updated_at": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"image_url",
"format",
"size",
"hidden",
"updated_at"
],
"type": "object"
},
"id": {
"description": "The ID of the image",
"example": "7",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"ImageStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"drop_shadow": {
"$ref": "#/components/schemas/ImageDropShadowStyles"
},
"horizontal_alignment": {
"default": "center",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "center",
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
},
"width": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"ImageUploadQuery": {
"properties": {
"file": {
"description": "The image file to upload. Supported image formats: jpeg,png,gif. Maximum image size: 5MB.",
"format": "binary",
"type": "string"
},
"hidden": {
"default": false,
"description": "If true, this image is not shown in the asset library.",
"type": "boolean"
},
"name": {
"description": "A name for the image. Defaults to the filename if not provided. If the name matches an existing image, a suffix will be added.",
"type": "string"
}
},
"required": [
"file"
],
"type": "object"
},
"ImmediateSendStrategy": {
"properties": {
"method": {
"enum": [
"immediate"
],
"type": "string"
}
},
"required": [
"method"
],
"type": "object"
},
"ImplicitlyOrExplicitlyReachable": {
"properties": {
"reachable_status": {
"enum": [
"implicitly_or_explicitly_reachable"
],
"type": "string"
}
},
"required": [
"reachable_status"
],
"type": "object"
},
"ImplicitlyOrExplicitlyUnreachable": {
"properties": {
"reachable_status": {
"enum": [
"implicitly_or_explicitly_unreachable"
],
"type": "string"
}
},
"required": [
"reachable_status"
],
"type": "object"
},
"ImplicitlyReachable": {
"properties": {
"reachable_status": {
"enum": [
"implicitly_reachable"
],
"type": "string"
}
},
"required": [
"reachable_status"
],
"type": "object"
},
"ImplicitlyUnreachable": {
"properties": {
"reachable_status": {
"enum": [
"implicitly_unreachable"
],
"type": "string"
}
},
"required": [
"reachable_status"
],
"type": "object"
},
"ImportErrorEnum": {
"enum": [
"import-error"
],
"type": "string"
},
"ImportErrorResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"code": {
"description": "A code for classifying the error type.",
"example": "invalid",
"type": "string"
},
"detail": {
"description": "Specific details about the error.",
"example": "The payload provided in the request is invalid.",
"type": "string"
},
"original_payload": {
"nullable": true,
"type": "object"
},
"source": {
"$ref": "#/components/schemas/ErrorSource",
"description": "Additional information on the source of the error."
},
"title": {
"description": "A high-level message about the error.",
"example": "Invalid input",
"type": "string"
}
},
"required": [
"code",
"title",
"detail",
"source"
],
"type": "object"
},
"id": {
"description": "Unique identifier for the error.",
"example": "e4eebb08-b055-4a6f-bb13-c8cb69c9eb94",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ImportErrorEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"InStringArrayFilter": {
"properties": {
"operator": {
"enum": [
"in"
],
"type": "string"
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"value": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"InTheLastBaseRelativeDateFilter": {
"properties": {
"operator": {
"enum": [
"in-the-last"
],
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"enum": [
"date"
],
"type": "string"
},
"unit": {
"description": "Units for relative date filters.",
"enum": [
"day",
"hour",
"week"
],
"type": "string"
}
},
"required": [
"type",
"operator",
"unit",
"quantity"
],
"type": "object"
},
"InboundMessageMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"inbound_message"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"Increment": {
"properties": {
"badge_config": {
"enum": [
"increment_one"
],
"type": "string"
}
},
"required": [
"badge_config"
],
"type": "object"
},
"InputStyles": {
"properties": {
"background_color": {
"default": "#FFFFFF",
"example": "#FFFFFF",
"type": "string"
},
"border_color": {
"default": "#949596",
"example": "#949596",
"type": "string"
},
"border_focus_color": {
"default": "#000000",
"example": "#000000",
"type": "string"
},
"corner_radius": {
"default": 2,
"example": 2,
"type": "integer"
},
"field_height": {
"default": 38,
"example": 38,
"type": "integer"
},
"focus_outline_color": {
"default": "#1C65AD",
"example": "#1C65AD",
"type": "string"
},
"label_color": {
"default": "#303B43",
"example": "#303B43",
"type": "string"
},
"placeholder_color": {
"default": "#949596",
"example": "#949596",
"type": "string"
},
"text_color": {
"default": "#000000",
"example": "#000000",
"type": "string"
},
"text_styles": {
"$ref": "#/components/schemas/TextStyleV0"
}
},
"type": "object"
},
"IntegerFilter": {
"properties": {
"operator": {
"description": "Operators for numeric filters.",
"enum": [
"equals",
"greater-than",
"greater-than-or-equal",
"less-than",
"less-than-or-equal",
"not-equals"
],
"type": "string"
},
"type": {
"enum": [
"numeric"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"InternalScheduledReportBuilderReportData": {
"properties": {
"report_id": {
"type": "string"
},
"service_method_type": {
"enum": [
"schedule-report-builder-report"
],
"type": "string"
}
},
"required": [
"service_method_type",
"report_id"
],
"type": "object"
},
"InternalScheduledReportData": {
"properties": {
"report_id": {
"type": "string"
},
"service_method_type": {
"enum": [
"schedule-report"
],
"type": "string"
}
},
"required": [
"service_method_type",
"report_id"
],
"type": "object"
},
"InternalServiceAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/InternalServiceActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"internal-service"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"InternalServiceActionData": {
"properties": {
"service_configuration": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/InternalScheduledReportData"
},
{
"$ref": "#/components/schemas/InternalTrackEventData"
},
{
"$ref": "#/components/schemas/InternalScheduledReportBuilderReportData"
},
{
"$ref": "#/components/schemas/InternalUnknownServiceData"
}
]
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"type": "object"
},
"InternalTrackEventData": {
"properties": {
"event_key": {
"nullable": true,
"type": "string"
},
"event_payload": {
"nullable": true,
"type": "object"
},
"service_method_type": {
"enum": [
"track-event"
],
"type": "string"
},
"tracking_company_id": {
"nullable": true,
"type": "string"
}
},
"required": [
"service_method_type"
],
"type": "object"
},
"InternalUnknownServiceData": {
"properties": {
"service_method_type": {
"enum": [
"unknown"
],
"type": "string"
}
},
"required": [
"service_method_type"
],
"type": "object"
},
"InvalidEmailDateFilter": {
"properties": {
"field": {
"enum": [
"invalid_email_date"
],
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/IsSetExistenceFilter"
}
]
}
},
"required": [
"field",
"filter"
],
"type": "object"
},
"IsSetExistenceFilter": {
"properties": {
"operator": {
"enum": [
"is-set"
],
"type": "string"
},
"type": {
"enum": [
"existence"
],
"type": "string"
}
},
"required": [
"type",
"operator"
],
"type": "object"
},
"LessThanPositiveNumericFilter": {
"properties": {
"operator": {
"enum": [
"less-than"
],
"type": "string"
},
"type": {
"enum": [
"numeric"
],
"type": "string"
},
"value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"Link": {
"properties": {
"next": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"LinkStyle": {
"properties": {
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"style_type": {
"enum": [
"link-styles"
],
"type": "string"
},
"styles": {
"$ref": "#/components/schemas/LinkStyleStyles"
}
},
"required": [
"style_type",
"styles"
],
"type": "object"
},
"LinkStyleStyles": {
"properties": {
"color": {
"nullable": true,
"type": "string"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"LinkStyles": {
"properties": {
"color": {
"default": "#0066cc",
"example": "#0066cc",
"type": "string"
},
"decoration": {
"default": "underline",
"enum": [
"underline"
],
"example": "underline",
"type": "string"
}
},
"type": "object"
},
"ListContainsOperatorListContainsFilter": {
"properties": {
"operator": {
"description": "Operators for list contains filters.",
"enum": [
"contains",
"not-contains"
],
"type": "string"
},
"type": {
"enum": [
"list"
],
"type": "string"
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ListCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ListCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ListCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"name": {
"description": "A helpful name to label the list",
"example": "Newsletter",
"type": "string"
},
"opt_in_process": {
"description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'. If not provided, uses account default.",
"enum": [
"double_opt_in",
"single_opt_in"
],
"example": "double_opt_in",
"nullable": true,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ListEnum": {
"enum": [
"list"
],
"type": "string"
},
"ListLengthFilter": {
"properties": {
"operator": {
"description": "Operators for list length filters.",
"enum": [
"length-equals",
"length-greater-than",
"length-greater-than-or-equal",
"length-less-than",
"length-less-than-or-equal"
],
"type": "string"
},
"type": {
"enum": [
"list"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ListListResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"name": {
"description": "A helpful name to label the list",
"example": "Newsletter",
"nullable": true,
"type": "string"
},
"opt_in_process": {
"description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
"enum": [
"double_opt_in",
"single_opt_in"
],
"example": "double_opt_in",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"ListMemberResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"joined_group_at": {
"description": "The datetime when this profile most recently joined the list.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"last_event_date": {
"description": "Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"joined_group_at"
],
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"push-tokens": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/PushTokenEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes",
"links"
],
"type": "object"
},
"ListMembersAddQuery": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"ListMembersDeleteQuery": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"ListPartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ListPartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ListPartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"name": {
"description": "A helpful name to label the list",
"example": "Newsletter",
"nullable": true,
"type": "string"
},
"opt_in_process": {
"description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
"enum": [
"double_opt_in",
"single_opt_in"
],
"example": "double_opt_in",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"ListRegexOperatorListContainsFilter": {
"properties": {
"operator": {
"description": "Operators for list regex filters.",
"enum": [
"contains-ends-with",
"contains-starts-with",
"not-contains-ends-with",
"not-contains-starts-with"
],
"type": "string"
},
"type": {
"enum": [
"list"
],
"type": "string"
},
"value": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "string"
}
]
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ListResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"name": {
"description": "A helpful name to label the list",
"example": "Newsletter",
"nullable": true,
"type": "string"
},
"opt_in_process": {
"description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
"enum": [
"double_opt_in",
"single_opt_in"
],
"example": "double_opt_in",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"ListRetrieveResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"name": {
"description": "A helpful name to label the list",
"example": "Newsletter",
"nullable": true,
"type": "string"
},
"opt_in_process": {
"description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
"enum": [
"double_opt_in",
"single_opt_in"
],
"example": "double_opt_in",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"ListSetFilter": {
"properties": {
"operator": {
"description": "Operators for list contains set filters.",
"enum": [
"contains-all",
"contains-any",
"not-contains-all",
"not-contains-any"
],
"type": "string"
},
"type": {
"enum": [
"list"
],
"type": "string"
},
"value": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ListSubstringFilter": {
"properties": {
"operator": {
"description": "Operators for list substring filters.",
"enum": [
"contains-substring",
"not-contains-substring"
],
"type": "string"
},
"type": {
"enum": [
"list"
],
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ListTrigger": {
"properties": {
"id": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"list"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ListUpdateAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/ListUpdateActionData"
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"list-update"
],
"type": "string"
}
},
"required": [
"data",
"type"
],
"type": "object"
},
"ListUpdateActionData": {
"properties": {
"list_id": {
"nullable": true,
"type": "string"
},
"name": {
"type": "string"
},
"on_execution": {
"description": "The enum for whether the action will add/remove from the list in the\n List Update Action.",
"enum": [
false,
true
],
"nullable": true,
"type": "boolean"
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"required": [
"name",
"on_execution",
"list_id"
],
"type": "object"
},
"ListsAndSegments": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/ListsAndSegmentsProperties"
},
"type": {
"enum": [
"lists_and_segments"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"ListsAndSegmentsProperties": {
"properties": {
"allow_list": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"deny_list": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"LocalStaticSend": {
"properties": {
"is_local": {
"description": "Whether the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time.",
"enum": [
true
],
"type": "boolean"
},
"send_past_recipients_immediately": {
"default": false,
"description": "Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends.",
"type": "boolean"
}
},
"required": [
"is_local"
],
"type": "object"
},
"Location": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/LocationProperties"
},
"type": {
"enum": [
"location"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"LocationProperties": {
"properties": {
"allow_list": {
"items": {
"oneOf": [
{
"description": "Geographic Regions.",
"enum": [
"con_AF",
"con_AS",
"con_EU",
"con_EUP",
"con_NA",
"con_OC",
"con_SA"
],
"type": "string"
},
{
"description": "Geographic Country - ISO 3166-1 alpha-2 country codes.",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AN",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BM",
"BN",
"BO",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"ST",
"SV",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"type": "string"
}
]
},
"nullable": true,
"type": "array"
},
"deny_list": {
"items": {
"oneOf": [
{
"description": "Geographic Regions.",
"enum": [
"con_AF",
"con_AS",
"con_EU",
"con_EUP",
"con_NA",
"con_OC",
"con_SA"
],
"type": "string"
},
{
"description": "Geographic Country - ISO 3166-1 alpha-2 country codes.",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AN",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AX",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BM",
"BN",
"BO",
"BR",
"BS",
"BT",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"CU",
"CV",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GB",
"GD",
"GE",
"GF",
"GG",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IM",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JE",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"ME",
"MG",
"MH",
"MK",
"ML",
"MM",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RS",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"ST",
"SV",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZW"
],
"type": "string"
}
]
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"LowInventoryCondition": {
"properties": {
"field": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
},
"metric_id": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"low-inventory-property"
],
"type": "string"
}
},
"required": [
"type",
"metric_id",
"field",
"filter"
],
"type": "object"
},
"LowInventoryTrigger": {
"properties": {
"audience": {
"items": {
"description": "The profiles which the low inventory trigger applies to.\n\nWe check profiles to see if they have these kinds of events. If they\n do have them, then they are considered for the audience.",
"enum": [
"added-to-cart",
"checkout-started",
"viewed"
],
"type": "string"
},
"type": "array"
},
"inventory_count": {
"type": "integer"
},
"product_level": {
"description": "Low inventory product level.",
"enum": [
"product",
"variant"
],
"type": "string"
},
"timeframe_days": {
"default": 30,
"example": 30,
"type": "integer"
},
"trigger_filter": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"$ref": "#/components/schemas/LowInventoryCondition"
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"type": {
"enum": [
"low-inventory"
],
"type": "string"
}
},
"required": [
"type",
"product_level",
"trigger_filter",
"inventory_count",
"audience"
],
"type": "object"
},
"MailboxProviderMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"mailbox_provider"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"ManualAddManualMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/InStringArrayFilter",
"description": "Optional filter on a specific list of user email addresses who initiated the manual action",
"nullable": true
},
"method": {
"enum": [
"manual_add"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"ManualImportManualMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/InStringArrayFilter",
"description": "Optional filter on a specific list of user email addresses who initiated the manual action",
"nullable": true
},
"method": {
"enum": [
"manual_import"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"ManualImportMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"manual_import"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"ManualRemoveMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"manual_remove"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"ManualSuppressionDateFilter": {
"properties": {
"field": {
"enum": [
"manual_suppression_date"
],
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/IsSetExistenceFilter"
}
]
}
},
"required": [
"field",
"filter"
],
"type": "object"
},
"MappedMetricEnum": {
"enum": [
"mapped-metric"
],
"type": "string"
},
"MappedMetricPartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/MappedMetricPartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"MappedMetricPartialUpdateQueryResourceObject": {
"properties": {
"id": {
"description": "The type of mapping.",
"enum": [
"added_to_cart",
"cancelled_sales",
"ordered_product",
"refunded_sales",
"revenue",
"started_checkout",
"viewed_product"
],
"example": "revenue",
"type": "string"
},
"relationships": {
"properties": {
"custom-metric": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The ID of the custom metric for this mapping. A null value will unset the mapping.",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CustomMetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
},
"metric": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The ID of the metric for this mapping. A null value will unset the mapping.",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/MappedMetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"MappedMetricResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"updated": {
"description": "The datetime when this mapping was last updated.",
"example": "2025-04-15T00:00:00Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"updated"
],
"type": "object"
},
"id": {
"description": "The type of mapping.",
"enum": [
"added_to_cart",
"cancelled_sales",
"ordered_product",
"refunded_sales",
"revenue",
"started_checkout",
"viewed_product"
],
"example": "revenue",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"custom-metric": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The ID of the custom metric for this mapping.",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CustomMetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"metric": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The ID of the metric for this mapping.",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/MappedMetricEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"Margin": {
"properties": {
"bottom": {
"default": 0,
"type": "integer"
},
"left": {
"default": 0,
"type": "integer"
},
"right": {
"default": 0,
"type": "integer"
},
"top": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"MessageBlockedMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"message_blocked"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"MethodFilter": {
"properties": {
"field": {
"enum": [
"subscribe_method"
],
"type": "string"
},
"method": {
"description": "Method for subscribing / unsubscribing.",
"enum": [
"api",
"back_in_stock",
"bigcommerce",
"bulk_remove",
"campaign_monitor",
"carrier_deactivation",
"checkout",
"constant_contact",
"exact_target",
"facebook",
"failed_age_gate",
"inbound_message",
"integration",
"mad_mimi",
"magento_two",
"mailbox_provider",
"manual_add",
"manual_import",
"manual_remove",
"message_blocked",
"netsuite",
"preference_page",
"provided_landline",
"provided_no_age",
"sftp",
"shopify",
"social_instagram_message",
"spam_complaint",
"square",
"wix",
"woocommerce"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"MetricAggregateEnum": {
"enum": [
"metric-aggregate"
],
"type": "string"
},
"MetricAggregateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/MetricAggregateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"MetricAggregateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"by": {
"description": "Optional attribute(s) used for partitioning by the aggregation function",
"example": [
"$message"
],
"items": {
"description": "Supported dimensions for grouping and filtering.\n\nIf adding a new dimension, the following will also need to be updated:\n - adding the key in keys.py\n - adding an AppMetricDimension to library.py\n - adding a new entry to the dict in the __init__ method of StaticSchema using the key from keys.py and the\n AppMetricDimension from library.py",
"enum": [
"$attributed_channel",
"$attributed_flow",
"$attributed_message",
"$attributed_variation",
"$campaign_channel",
"$flow",
"$flow_channel",
"$message",
"$message_send_cohort",
"$usage_amount",
"$value_currency",
"$variation",
"$variation_send_cohort",
"Bot Click",
"Bounce Type",
"Campaign Name",
"Client Canonical",
"Client Name",
"Client Type",
"Email Domain",
"Failure Source",
"Failure Type",
"From Number",
"From Phone Region",
"Inbox Provider",
"List",
"Message Format",
"Message Name",
"Message Type",
"Method",
"Segment Count",
"Subject",
"To Number",
"To Phone Region",
"URL",
"form_id"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"filter": {
"description": "List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).\n These filters follow a similar format to those in `GET` requests, the primary difference is that this endpoint asks for a list.\n The time range can be filtered by providing a `greater-or-equal` and a `less-than` filter on the `datetime` field.",
"example": [
"greater-or-equal(datetime,2022-12-01T00:00:00)",
"less-than(datetime,2022-12-08T00:00:00"
],
"items": {
"type": "string"
},
"type": "array"
},
"interval": {
"default": "day",
"description": "Aggregation interval, e.g. \"hour\", \"day\", \"week\", \"month\"",
"enum": [
"day",
"hour",
"month",
"week"
],
"example": "day",
"nullable": true,
"type": "string"
},
"measurements": {
"description": "Measurement key, e.g. `unique`, `sum_value`, `count`",
"example": [
"count"
],
"items": {
"description": "Supported measurements for aggregation",
"enum": [
"count",
"sum_value",
"unique"
],
"type": "string"
},
"type": "array"
},
"metric_id": {
"description": "The metric ID used in the aggregation.",
"example": "0rG4eQ",
"type": "string"
},
"page_cursor": {
"description": "Optional pagination cursor to iterate over large result sets",
"type": "string"
},
"page_size": {
"default": 500,
"description": "Alter the maximum number of returned rows in a single page of aggregation results",
"example": 500,
"nullable": true,
"type": "integer"
},
"return_fields": {
"description": "Provide fields to limit the returned data",
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"sort": {
"description": "Provide a sort key (e.g. -$message)",
"enum": [
"$attributed_channel",
"-$attributed_channel",
"$attributed_flow",
"-$attributed_flow",
"$attributed_message",
"-$attributed_message",
"$attributed_variation",
"-$attributed_variation",
"$campaign_channel",
"-$campaign_channel",
"$flow",
"-$flow",
"$flow_channel",
"-$flow_channel",
"$message",
"-$message",
"$message_send_cohort",
"-$message_send_cohort",
"$usage_amount",
"-$usage_amount",
"$value_currency",
"-$value_currency",
"$variation",
"-$variation",
"$variation_send_cohort",
"-$variation_send_cohort",
"Bot Click",
"-Bot Click",
"Bounce Type",
"-Bounce Type",
"Campaign Name",
"-Campaign Name",
"Client Canonical",
"-Client Canonical",
"Client Name",
"-Client Name",
"Client Type",
"-Client Type",
"Email Domain",
"-Email Domain",
"Failure Source",
"-Failure Source",
"Failure Type",
"-Failure Type",
"From Number",
"-From Number",
"From Phone Region",
"-From Phone Region",
"Inbox Provider",
"-Inbox Provider",
"List",
"-List",
"Message Format",
"-Message Format",
"Message Name",
"-Message Name",
"Message Type",
"-Message Type",
"Method",
"-Method",
"Segment Count",
"-Segment Count",
"Subject",
"-Subject",
"To Number",
"-To Number",
"To Phone Region",
"-To Phone Region",
"URL",
"-URL",
"count",
"-count",
"form_id",
"-form_id",
"sum_value",
"-sum_value",
"unique",
"-unique"
],
"type": "string"
},
"timezone": {
"default": "UTC",
"description": "The timezone used for processing the query, e.g. `'America/New_York'`.\n This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones).\n While most are supported, a few notable exceptions are `Factory`, `Europe/Kyiv` and `Pacific/Kanton`. This field is case-sensitive.",
"example": "America/New_York",
"nullable": true,
"type": "string"
}
},
"required": [
"metric_id",
"measurements",
"filter"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/MetricAggregateEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"MetricAggregateRowDTO": {
"properties": {
"dimensions": {
"description": "List of dimensions associated with this set of measurements",
"items": {
"type": "string"
},
"type": "array"
},
"measurements": {
"description": "Dictionary of measurement_key, values",
"type": "object"
}
},
"required": [
"dimensions",
"measurements"
],
"type": "object"
},
"MetricCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"name": {
"description": "Name of the event. Must be less than 128 characters.",
"example": "Viewed Product",
"type": "string"
},
"service": {
"description": "This is for advanced usage. For api requests, this should use the default, which is set to api.",
"nullable": true,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"MetricEnum": {
"enum": [
"metric"
],
"type": "string"
},
"MetricPropertyCondition": {
"properties": {
"field": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
},
"metric_id": {
"type": "string"
},
"type": {
"enum": [
"metric-property"
],
"type": "string"
}
},
"required": [
"type",
"metric_id",
"field",
"filter"
],
"type": "object"
},
"MetricPropertyEnum": {
"enum": [
"metric-property"
],
"type": "string"
},
"MetricPropertyResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"inferred_type": {
"description": "Inferred type for this metric property",
"example": "List",
"type": "string"
},
"label": {
"description": "The label for this metric property",
"example": "Categories",
"type": "string"
},
"property": {
"description": "The property for this metric property",
"example": "Categories",
"type": "string"
}
},
"required": [
"label",
"property",
"inferred_type"
],
"type": "object"
},
"id": {
"description": "The ID of the metric property",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"metric": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Related Metric",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/MetricPropertyEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"MetricResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Creation time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"nullable": true,
"type": "string"
},
"integration": {
"description": "The integration associated with the event",
"nullable": true,
"type": "object"
},
"name": {
"description": "The name of the metric",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Last updated time in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The Metric ID",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"MetricTrigger": {
"properties": {
"id": {
"nullable": true,
"type": "string"
},
"trigger_filter": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"$ref": "#/components/schemas/MetricPropertyCondition"
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"type": {
"enum": [
"metric"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"MobileOverlay": {
"properties": {
"color": {
"default": "rgba(20, 20, 20, 0.5)",
"example": "rgba(20, 20, 20, 0.5)",
"nullable": true,
"type": "string"
},
"enabled": {
"default": false,
"enum": [
false
],
"type": "boolean"
}
},
"type": "object"
},
"MobilePushBadge": {
"properties": {
"badge_options": {
"description": "Badge options",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CampaignMessageIncrement"
},
{
"$ref": "#/components/schemas/CampaignMessageStaticCount"
},
{
"$ref": "#/components/schemas/CampaignMessageProperty"
}
]
},
"display": {
"description": "Whether to display a badge on the app icon",
"enum": [
true
],
"type": "boolean"
}
},
"required": [
"display"
],
"type": "object"
},
"MobilePushContent": {
"properties": {
"action_buttons": {
"description": "Action buttons for the push notification",
"items": {
"$ref": "#/components/schemas/PushActionButtonDefinition"
},
"nullable": true,
"type": "array"
},
"body": {
"description": "The message body",
"example": "My preview push notification",
"nullable": true,
"type": "string"
},
"dynamic_image": {
"description": "The dynamic image to be used in the push notification",
"nullable": true,
"type": "string"
},
"title": {
"description": "The title of the message",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"MobilePushContentCreate": {
"properties": {
"action_buttons": {
"description": "Action buttons for the push notification (max 3, positions 0-indexed with no gaps)",
"items": {
"$ref": "#/components/schemas/PushActionButtonDefinition"
},
"nullable": true,
"type": "array"
},
"body": {
"description": "The message body",
"example": "My preview push notification",
"type": "string"
},
"dynamic_image": {
"description": "The dynamic image to be used in the push notification",
"nullable": true,
"type": "string"
},
"title": {
"description": "The title of the message",
"nullable": true,
"type": "string"
}
},
"required": [
"body"
],
"type": "object"
},
"MobilePushContentUpdate": {
"properties": {
"action_buttons": {
"description": "Action buttons for the push notification (max 3, positions 0-indexed with no gaps)",
"items": {
"$ref": "#/components/schemas/PushActionButtonDefinition"
},
"nullable": true,
"type": "array"
},
"body": {
"description": "The message body",
"example": "My preview push notification",
"nullable": true,
"type": "string"
},
"dynamic_image": {
"description": "The dynamic image to be used in the push notification",
"nullable": true,
"type": "string"
},
"title": {
"description": "The title of the message",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"MobilePushMessageSilentDefinition": {
"properties": {
"channel": {
"enum": [
"mobile_push"
],
"type": "string"
},
"kv_pairs": {
"description": "The key-value pairs to be sent with the push notification",
"nullable": true,
"type": "object"
},
"notification_type": {
"description": "The type of notification to send",
"enum": [
"silent"
],
"type": "string"
}
},
"required": [
"channel",
"notification_type"
],
"type": "object"
},
"MobilePushMessageSilentDefinitionCreate": {
"properties": {
"channel": {
"enum": [
"mobile_push"
],
"type": "string"
},
"kv_pairs": {
"description": "The key-value pairs to be sent with the push notification",
"nullable": true,
"type": "object"
},
"notification_type": {
"default": "silent",
"description": "The type of notification to send",
"enum": [
"silent"
],
"example": "silent",
"type": "string"
}
},
"required": [
"channel"
],
"type": "object"
},
"MobilePushMessageSilentDefinitionUpdate": {
"properties": {
"channel": {
"enum": [
"mobile_push"
],
"type": "string"
},
"kv_pairs": {
"description": "The key-value pairs to be sent with the push notification",
"type": "object"
},
"notification_type": {
"default": "silent",
"description": "The type of notification to send",
"enum": [
"silent"
],
"example": "silent",
"type": "string"
}
},
"required": [
"channel"
],
"type": "object"
},
"MobilePushMessageStandardDefinition": {
"properties": {
"channel": {
"enum": [
"mobile_push"
],
"type": "string"
},
"content": {
"$ref": "#/components/schemas/MobilePushContent",
"description": "Additional attributes relating to the content of the message"
},
"kv_pairs": {
"description": "The key-value pairs to be sent with the push notification",
"nullable": true,
"type": "object"
},
"notification_type": {
"description": "The type of notification to send",
"enum": [
"standard"
],
"type": "string"
},
"options": {
"$ref": "#/components/schemas/MobilePushOptions",
"nullable": true
}
},
"required": [
"channel",
"notification_type",
"content"
],
"type": "object"
},
"MobilePushMessageStandardDefinitionCreate": {
"properties": {
"channel": {
"enum": [
"mobile_push"
],
"type": "string"
},
"content": {
"$ref": "#/components/schemas/MobilePushContentCreate",
"description": "Additional attributes relating to the content of the message"
},
"kv_pairs": {
"description": "The key-value pairs to be sent with the push notification",
"nullable": true,
"type": "object"
},
"notification_type": {
"default": "standard",
"description": "The type of notification to send",
"enum": [
"standard"
],
"example": "standard",
"type": "string"
},
"options": {
"$ref": "#/components/schemas/MobilePushOptions",
"nullable": true
}
},
"required": [
"channel",
"content"
],
"type": "object"
},
"MobilePushMessageStandardDefinitionUpdate": {
"properties": {
"channel": {
"enum": [
"mobile_push"
],
"type": "string"
},
"content": {
"$ref": "#/components/schemas/MobilePushContentUpdate",
"description": "Additional attributes relating to the content of the message",
"nullable": true
},
"kv_pairs": {
"description": "The key-value pairs to be sent with the push notification",
"nullable": true,
"type": "object"
},
"notification_type": {
"default": "standard",
"description": "The type of notification to send",
"enum": [
"standard"
],
"example": "standard",
"type": "string"
},
"options": {
"$ref": "#/components/schemas/MobilePushOptions",
"description": "Additional device specific options for the push notification",
"nullable": true
}
},
"required": [
"channel"
],
"type": "object"
},
"MobilePushNoBadge": {
"properties": {
"display": {
"description": "Whether to display a badge on the app icon",
"enum": [
false
],
"type": "boolean"
}
},
"required": [
"display"
],
"type": "object"
},
"MobilePushOptions": {
"properties": {
"badge": {
"description": "Only supported on iOS.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/MobilePushBadge"
},
{
"$ref": "#/components/schemas/MobilePushNoBadge"
}
]
},
"on_open": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/PushOnOpenApp"
},
{
"$ref": "#/components/schemas/PushOnOpenDeepLink"
},
{
"$ref": "#/components/schemas/PushOnOpenWebUrl"
}
]
},
"play_sound": {
"default": false,
"description": "Only supported on iOS.",
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"MobileStyle": {
"properties": {
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/MobileStyleProperties"
},
"style_type": {
"enum": [
"mobile-styles"
],
"type": "string"
},
"styles": {
"$ref": "#/components/schemas/MobileStyleStyles"
}
},
"required": [
"style_type",
"properties",
"styles"
],
"type": "object"
},
"MobileStyleProperties": {
"properties": {
"mobile_padding_override": {
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"MobileStyleStyles": {
"properties": {
"mobile_block_padding_left": {
"nullable": true,
"type": "integer"
},
"mobile_block_padding_right": {
"nullable": true,
"type": "integer"
},
"mobile_margin": {
"nullable": true,
"type": "integer"
},
"mobile_padding_bottom": {
"nullable": true,
"type": "integer"
},
"mobile_padding_left": {
"nullable": true,
"type": "integer"
},
"mobile_padding_right": {
"nullable": true,
"type": "integer"
},
"mobile_padding_top": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"MultiBranchSplitAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/MultiBranchSplitActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"multi-branch-split"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"MultiBranchSplitActionData": {
"properties": {
"branches": {
"items": {
"$ref": "#/components/schemas/MultiBranchSplitBranch"
},
"type": "array"
},
"name": {
"type": "string"
}
},
"required": [
"branches",
"name"
],
"type": "object"
},
"MultiBranchSplitBranch": {
"properties": {
"branch_filter": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfilePropertyCondition"
},
{
"$ref": "#/components/schemas/ProfileHasGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileNoGroupMembershipCondition"
},
{
"$ref": "#/components/schemas/ProfileRegionCondition"
},
{
"$ref": "#/components/schemas/ProfilePostalCodeDistanceCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsDateCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsNumericCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityPriorityCondition"
},
{
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankCondition"
},
{
"$ref": "#/components/schemas/ProfileMarketingConsentCondition"
},
{
"$ref": "#/components/schemas/FlowsProfileMetricCondition"
},
{
"$ref": "#/components/schemas/ProfileRandomSampleCondition"
},
{
"$ref": "#/components/schemas/ProfileHasCustomObjectCondition"
},
{
"$ref": "#/components/schemas/ProfilePermissionsCondition"
},
{
"$ref": "#/components/schemas/MetricPropertyCondition"
},
{
"$ref": "#/components/schemas/CustomObjectTriggerCondition"
}
]
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"branch_id": {
"type": "string"
},
"is_else": {
"default": false,
"type": "boolean"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"name": {
"nullable": true,
"type": "string"
},
"order": {
"nullable": true,
"type": "integer"
}
},
"required": [
"branch_id"
],
"type": "object"
},
"NextStep": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/NextStepProperties",
"nullable": true
},
"submit": {
"type": "boolean"
},
"type": {
"enum": [
"next_step"
],
"type": "string"
}
},
"required": [
"submit",
"type"
],
"type": "object"
},
"NextStepProperties": {
"properties": {
"list_id": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"NoEmailMarketing": {
"properties": {
"filters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BounceDateFilter"
},
{
"$ref": "#/components/schemas/ManualSuppressionDateFilter"
},
{
"$ref": "#/components/schemas/InvalidEmailDateFilter"
}
]
},
"nullable": true,
"type": "array"
},
"subscription": {
"enum": [
"any"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"NoEmailMarketingConsent": {
"properties": {
"can_receive_marketing": {
"enum": [
false
],
"type": "boolean"
},
"channel": {
"enum": [
"email"
],
"type": "string"
},
"consent_status": {
"oneOf": [
{
"$ref": "#/components/schemas/NoEmailMarketing"
},
{
"$ref": "#/components/schemas/NoEmailMarketingUnsubscribed"
},
{
"$ref": "#/components/schemas/NoEmailMarketingNeverSubscribed"
},
{
"$ref": "#/components/schemas/NoEmailMarketingSubscribed"
}
]
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
],
"type": "object"
},
"NoEmailMarketingNeverSubscribed": {
"properties": {
"filters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BounceDateFilter"
},
{
"$ref": "#/components/schemas/ManualSuppressionDateFilter"
},
{
"$ref": "#/components/schemas/InvalidEmailDateFilter"
}
]
},
"type": "array"
},
"subscription": {
"enum": [
"never_subscribed"
],
"type": "string"
}
},
"required": [
"subscription",
"filters"
],
"type": "object"
},
"NoEmailMarketingSubscribed": {
"properties": {
"filters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BounceDateFilter"
},
{
"$ref": "#/components/schemas/ManualSuppressionDateFilter"
},
{
"$ref": "#/components/schemas/InvalidEmailDateFilter"
}
]
},
"type": "array"
},
"subscription": {
"enum": [
"subscribed"
],
"type": "string"
}
},
"required": [
"subscription",
"filters"
],
"type": "object"
},
"NoEmailMarketingUnsubscribed": {
"properties": {
"filters": {
"nullable": true,
"oneOf": [
{
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/StatusDateFilter"
},
{
"$ref": "#/components/schemas/APIMethodFilter"
},
{
"$ref": "#/components/schemas/InboundMessageMethodFilter"
},
{
"$ref": "#/components/schemas/PreferencePageMethodFilter"
},
{
"$ref": "#/components/schemas/ManualRemoveMethodFilter"
},
{
"$ref": "#/components/schemas/SpamComplaintMethodFilter"
},
{
"$ref": "#/components/schemas/MailboxProviderMethodFilter"
},
{
"$ref": "#/components/schemas/OneClickUnsubscribeMethodFilter"
},
{
"$ref": "#/components/schemas/ManualImportMethodFilter"
},
{
"$ref": "#/components/schemas/SftpMethodFilter"
},
{
"$ref": "#/components/schemas/DataWarehouseImportMethodFilter"
},
{
"$ref": "#/components/schemas/ProfileModificationMethodFilter"
},
{
"$ref": "#/components/schemas/ConstantContactIntegrationMethodFilter"
}
]
},
"type": "array"
},
{
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BounceDateFilter"
},
{
"$ref": "#/components/schemas/ManualSuppressionDateFilter"
},
{
"$ref": "#/components/schemas/InvalidEmailDateFilter"
}
]
},
"type": "array"
}
]
},
"subscription": {
"enum": [
"unsubscribed"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"NoPushMarketing": {
"properties": {
"subscription": {
"enum": [
"any"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"NoPushMarketingConsent": {
"properties": {
"can_receive_marketing": {
"enum": [
false
],
"type": "boolean"
},
"channel": {
"enum": [
"push"
],
"type": "string"
},
"consent_status": {
"$ref": "#/components/schemas/NoPushMarketing"
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
],
"type": "object"
},
"NoSMSMarketing": {
"properties": {
"subscription": {
"enum": [
"any"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"NoSMSMarketingConsent": {
"properties": {
"can_receive_marketing": {
"enum": [
false
],
"type": "boolean"
},
"channel": {
"enum": [
"sms"
],
"type": "string"
},
"consent_status": {
"oneOf": [
{
"$ref": "#/components/schemas/NoSMSMarketing"
},
{
"$ref": "#/components/schemas/NoSMSMarketingUnsubscribed"
},
{
"$ref": "#/components/schemas/NoSMSMarketingNeverSubscribed"
}
]
}
},
"required": [
"channel",
"can_receive_marketing",
"consent_status"
],
"type": "object"
},
"NoSMSMarketingNeverSubscribed": {
"properties": {
"subscription": {
"enum": [
"never_subscribed"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"NoSMSMarketingUnsubscribed": {
"properties": {
"filters": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/StatusDateFilter"
},
{
"$ref": "#/components/schemas/FormMethodFilter"
},
{
"$ref": "#/components/schemas/ManualImportManualMethodFilter"
},
{
"$ref": "#/components/schemas/ManualAddManualMethodFilter"
},
{
"$ref": "#/components/schemas/ManualRemoveMethodFilter"
},
{
"$ref": "#/components/schemas/BulkRemoveMethodFilter"
},
{
"$ref": "#/components/schemas/CheckoutMethodFilter"
},
{
"$ref": "#/components/schemas/InboundMessageMethodFilter"
},
{
"$ref": "#/components/schemas/PreferencePageMethodFilter"
},
{
"$ref": "#/components/schemas/SftpMethodFilter"
},
{
"$ref": "#/components/schemas/CarrierDeactivationMethodFilter"
},
{
"$ref": "#/components/schemas/ProvidedLandlineMethodFilter"
},
{
"$ref": "#/components/schemas/MessageBlockedMethodFilter"
},
{
"$ref": "#/components/schemas/ProvidedNoAgeMethodFilter"
},
{
"$ref": "#/components/schemas/FailedAgeGateMethodFilter"
},
{
"$ref": "#/components/schemas/ShopifyIntegrationMethodFilter"
}
]
},
"nullable": true,
"type": "array"
},
"subscription": {
"enum": [
"unsubscribed"
],
"type": "string"
}
},
"required": [
"subscription"
],
"type": "object"
},
"NonLocalStaticSend": {
"properties": {
"is_local": {
"description": "Whether the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time.",
"enum": [
false
],
"type": "boolean"
}
},
"required": [
"is_local"
],
"type": "object"
},
"NumericOperatorNumericFilter": {
"properties": {
"operator": {
"description": "Operators for numeric filters.",
"enum": [
"equals",
"greater-than",
"greater-than-or-equal",
"less-than",
"less-than-or-equal",
"not-equals"
],
"type": "string"
},
"type": {
"enum": [
"numeric"
],
"type": "string"
},
"value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"NumericRangeFilter": {
"properties": {
"end": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
},
"operator": {
"description": "Operators for numeric range filters.",
"enum": [
"between"
],
"type": "string"
},
"start": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
},
"type": {
"enum": [
"numeric"
],
"type": "string"
}
},
"required": [
"type",
"operator",
"start",
"end"
],
"type": "object"
},
"ObjectLinks": {
"properties": {
"self": {
"format": "uri",
"type": "string"
}
},
"required": [
"self"
],
"type": "object"
},
"OneClickUnsubscribeMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"one_click_unsubscribe"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"OnlyRelatedLinks": {
"properties": {
"related": {
"format": "uri",
"type": "string"
}
},
"required": [
"related"
],
"type": "object"
},
"OnsiteProfileCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/OnsiteProfileCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"OnsiteProfileCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"_kx": {
"description": "Also known as the `exchange_id`, this is an encrypted identifier used for identifying a\nprofile by Klaviyo's web tracking.\n\nYou can use this field as a filter when retrieving profiles via the Get Profiles endpoint.",
"nullable": true,
"type": "string"
},
"anonymous_id": {
"nullable": true,
"type": "string"
},
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"nullable": true,
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/OnsiteProfileMeta",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"OnsiteProfileMeta": {
"properties": {
"patch_identifiers": {
"$ref": "#/components/schemas/PatchIdentifiers",
"description": "Specify one or more patch operations to apply to existing identifier data. Currently only `email` is supported, and it is used to add or remove secondary email addresses on a profile.",
"example": {
"append": {
"email": [
"example@test.com",
"another@example.com"
]
}
},
"nullable": true
},
"patch_properties": {
"$ref": "#/components/schemas/ProfileMetaPatchProperties",
"description": "Specify one or more patch operations to apply to existing property data",
"example": {
"append": {
"skus": "92538"
}
},
"nullable": true
}
},
"type": "object"
},
"OnsiteSubscriptionCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/OnsiteSubscriptionCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"OnsiteSubscriptionCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"custom_source": {
"description": "A custom method detail or source to store on the consent records for this subscription.",
"example": "Homepage footer signup form",
"nullable": true,
"type": "string"
},
"profile": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileUpsertQueryWithSubscriptionsResourceObject"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"profile"
],
"type": "object"
},
"relationships": {
"properties": {
"list": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The list ID to add the newly subscribed profile to.",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"list"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SubscriptionEnum"
}
},
"required": [
"type",
"attributes",
"relationships"
],
"type": "object"
},
"OpenForm": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/OpenFormProperties"
},
"submit": {
"default": true,
"enum": [
true
],
"example": true,
"type": "boolean"
},
"type": {
"enum": [
"open_form"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"OpenFormProperties": {
"properties": {
"close_form": {
"default": true,
"example": true,
"type": "boolean"
},
"form_id_to_open": {
"type": "string"
}
},
"required": [
"form_id_to_open"
],
"type": "object"
},
"OptInCode": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/OptInCodeProperties"
},
"styles": {
"$ref": "#/components/schemas/OptInCodeStyles"
},
"type": {
"enum": [
"opt_in_code"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"OptInCodeProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"placeholder": {
"nullable": true,
"type": "string"
},
"property_name": {
"default": "opt_in_code",
"enum": [
"opt_in_code"
],
"example": "opt_in_code",
"type": "string"
},
"required": {
"default": true,
"enum": [
true
],
"example": true,
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
"OptInCodeStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"OrderEnum": {
"enum": [
"order"
],
"type": "string"
},
"Padding": {
"properties": {
"bottom": {
"default": 0,
"type": "integer"
},
"left": {
"default": 0,
"type": "integer"
},
"right": {
"default": 0,
"type": "integer"
},
"top": {
"default": 0,
"type": "integer"
}
},
"type": "object"
},
"PageVisits": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/PageVisitsProperties"
},
"type": {
"enum": [
"page_visits"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"PageVisitsProperties": {
"properties": {
"pages": {
"default": 3,
"example": 3,
"type": "integer"
}
},
"type": "object"
},
"PatchCampaignMessageResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created_at": {
"description": "The datetime when the message was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/EmailMessageDefinition"
},
{
"$ref": "#/components/schemas/SMSMessageDefinition"
},
{
"$ref": "#/components/schemas/MobilePushMessageStandardDefinition"
},
{
"$ref": "#/components/schemas/MobilePushMessageSilentDefinition"
}
]
},
"send_times": {
"description": "The list of appropriate Send Time Sub-objects associated with the message",
"items": {
"$ref": "#/components/schemas/SendTime"
},
"nullable": true,
"type": "array"
},
"updated_at": {
"description": "The datetime when the message was last updated",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The message ID",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"campaign": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The parent campaign id",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"image": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The associated image id",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"template": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The associated template id",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchCampaignResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"archived": {
"description": "Whether the campaign has been archived or not",
"type": "boolean"
},
"audiences": {
"$ref": "#/components/schemas/Audiences",
"description": "The audiences to be included and/or excluded from the campaign"
},
"created_at": {
"description": "The datetime when the campaign was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"name": {
"description": "The campaign name",
"type": "string"
},
"scheduled_at": {
"description": "The datetime when the campaign was scheduled for future sending",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"send_options": {
"description": "Options to use when sending a campaign",
"oneOf": [
{
"$ref": "#/components/schemas/EmailSendOptions"
},
{
"$ref": "#/components/schemas/SMSSendOptions"
},
{
"$ref": "#/components/schemas/PushSendOptions"
}
]
},
"send_strategy": {
"description": "The send strategy the campaign will send with",
"oneOf": [
{
"$ref": "#/components/schemas/StaticSendStrategy"
},
{
"$ref": "#/components/schemas/SmartSendTimeStrategy"
},
{
"$ref": "#/components/schemas/ThrottledSendStrategy"
},
{
"$ref": "#/components/schemas/ImmediateSendStrategy"
},
{
"$ref": "#/components/schemas/ABTestSendStrategy"
},
{
"$ref": "#/components/schemas/UnsupportedSendStrategy"
}
]
},
"send_time": {
"description": "The datetime when the campaign will be / was sent or None if not yet scheduled by a send_job.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "The current status of the campaign",
"enum": [
"Adding Recipients",
"Cancelled",
"Cancelled: Account Disabled",
"Cancelled: Billing Limit",
"Cancelled: Internal Error",
"Cancelled: Misconfigured",
"Cancelled: No Recipients",
"Cancelled: Smart Sending",
"Draft",
"Preparing to schedule",
"Preparing to send",
"Queued without Recipients",
"Scheduled",
"Sending",
"Sending Segments",
"Sent",
"Unknown",
"Variations Sent"
],
"type": "string"
},
"tracking_options": {
"description": "The tracking options associated with the campaign",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CampaignsEmailTrackingOptions"
},
{
"$ref": "#/components/schemas/CampaignsSMSTrackingOptions"
}
]
},
"updated_at": {
"description": "The datetime when the campaign was last updated by a user or the system",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"status",
"archived",
"audiences",
"send_options",
"send_strategy",
"created_at",
"updated_at"
],
"type": "object"
},
"id": {
"description": "The campaign ID",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"campaign-messages": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The message(s) associated with the campaign",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchCatalogCategoryResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"external_id": {
"description": "The ID of the catalog category in an external system.",
"example": "SAMPLE-DATA-CATEGORY-APPAREL",
"nullable": true,
"type": "string"
},
"name": {
"description": "The name of the catalog category.",
"example": "Sample Data Category Apparel",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the catalog category was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchCatalogItemResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the catalog item was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.",
"example": {
"Top Pick": true
},
"nullable": true,
"type": "object"
},
"description": {
"description": "A description of the catalog item.",
"example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "The ID of the catalog item in an external system.",
"example": "SAMPLE-DATA-ITEM-1",
"nullable": true,
"type": "string"
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item.",
"example": "https://via.placeholder.com/300",
"nullable": true,
"type": "string"
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item.",
"example": [
"https://via.placeholder.com/150"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"price": {
"description": "This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).",
"example": 42,
"nullable": true,
"type": "number"
},
"published": {
"description": "Boolean value indicating whether the catalog item is published.",
"example": true,
"nullable": true,
"type": "boolean"
},
"title": {
"description": "The title of the catalog item.",
"example": "Ocean Blue Shirt (Sample)",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the catalog item was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"url": {
"description": "URL pointing to the location of the catalog item on your website.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"variants": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchCatalogVariantResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the catalog item variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
"example": {
"Top Pick": true
},
"nullable": true,
"type": "object"
},
"description": {
"description": "A description of the catalog item variant.",
"example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "The ID of the catalog item variant in an external system.",
"example": "SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"nullable": true,
"type": "string"
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item variant.",
"example": "https://via.placeholder.com/300",
"nullable": true,
"type": "string"
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item variant.",
"example": [
"https://via.placeholder.com/150"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"inventory_policy": {
"description": "This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.",
"enum": [
0,
1,
2
],
"example": 2,
"nullable": true,
"type": "integer"
},
"inventory_quantity": {
"description": "The quantity of the catalog item variant currently in stock.",
"example": 25,
"nullable": true,
"type": "number"
},
"price": {
"description": "This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).",
"example": 42,
"nullable": true,
"type": "number"
},
"published": {
"description": "Boolean value indicating whether the catalog item variant is published.",
"example": true,
"nullable": true,
"type": "boolean"
},
"sku": {
"description": "The SKU of the catalog item variant.",
"example": "OBS-MD",
"nullable": true,
"type": "string"
},
"title": {
"description": "The title of the catalog item variant.",
"example": "Ocean Blue Shirt (Sample) Variant Medium",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"url": {
"description": "URL pointing to the location of the catalog item variant on your website.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"item": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchCouponCodeResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"expires_at": {
"description": "The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "The current status of the coupon code.",
"enum": [
"ASSIGNED_TO_PROFILE",
"DELETING",
"PROCESSING",
"UNASSIGNED",
"USED",
"VERSION_NOT_ACTIVE"
],
"example": "UNASSIGNED",
"nullable": true,
"type": "string"
},
"unique_code": {
"description": "This is a unique string that will be or is assigned to each customer/profile and is associated with a coupon.",
"example": "ASD325FHK324UJDOI2M3JNES99",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"coupon": {
"properties": {
"data": {
"properties": {
"id": {
"example": "10OFF",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CouponEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profile": {
"properties": {
"data": {
"properties": {
"id": {
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CouponCodeEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchCouponResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"description": {
"description": "A description of the coupon.",
"example": "10% off for purchases over $50",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "This is the id that is stored in an integration such as Shopify or Magento.",
"example": "10OFF",
"type": "string"
},
"monitor_configuration": {
"description": "The monitor configuration for the coupon.",
"example": {
"low_balance_threshold": 500
},
"nullable": true,
"type": "object"
}
},
"required": [
"external_id"
],
"type": "object"
},
"id": {
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"example": "10OFF",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/CouponEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchCustomMetricResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "The datetime when this custom metric was created.",
"example": "2025-04-15T00:00:00Z",
"format": "date-time",
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/CustomMetricDefinition",
"description": "The definition of a custom metric. It is composed of a list of `metric_groups`. Each group specifies how to query a particular metric with customized filters and the value property to calculate conversion value measurements (if applicable). The groups are combined with `AND` relationships, i.e., conversion and conversion value measurements for each group will be added together to get the final result.",
"example": {
"aggregation_method": "value",
"metric_groups": [
{
"metric_filters": [
{
"filter": {
"operator": "starts-with",
"type": "string",
"value": "some_substring"
},
"property": "my_string_property"
},
{
"filter": {
"operator": "greater-than-or-equal",
"type": "numeric",
"value": 999
},
"property": "my_numeric_property"
}
],
"metric_id": "AAAAAA",
"value_property": "$value"
},
{
"metric_filters": [
{
"filter": {
"operator": "equals",
"type": "boolean",
"value": false
},
"property": "my_boolean_property"
},
{
"filter": {
"operator": "contains",
"type": "list",
"value": "some_value_in_a_list"
},
"property": "my_list_property"
}
],
"metric_id": "BBBBBB",
"value_property": "my_numeric_property"
}
]
}
},
"name": {
"description": "The name for this custom metric. Names must be unique across the account. Attempting to create a metric with a duplicate name will return a 400 status code.",
"example": "My custom metric",
"type": "string"
},
"updated": {
"description": "The datetime when this custom metric was updated.",
"example": "2025-04-15T00:00:00Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"created",
"updated",
"definition"
],
"type": "object"
},
"id": {
"description": "The ID of the custom metric",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"metrics": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Related metrics",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CustomMetricEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchFlowActionEncodedResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"description": "The encoded flow action definition.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ActionOutputSplitAction"
},
{
"$ref": "#/components/schemas/BackInStockDelayAction"
},
{
"$ref": "#/components/schemas/ConditionalBranchAction"
},
{
"$ref": "#/components/schemas/ContentExperimentAction"
},
{
"$ref": "#/components/schemas/SendEmailAction"
},
{
"$ref": "#/components/schemas/SendPushNotificationAction"
},
{
"$ref": "#/components/schemas/SendSmsAction"
},
{
"$ref": "#/components/schemas/SendWebhookAction"
},
{
"$ref": "#/components/schemas/SendInternalAlertAction"
},
{
"$ref": "#/components/schemas/SendWhatsAppAction"
},
{
"$ref": "#/components/schemas/TimeDelayAction"
},
{
"$ref": "#/components/schemas/TriggerBranchAction"
},
{
"$ref": "#/components/schemas/UpdateProfileAction"
},
{
"$ref": "#/components/schemas/TargetDateAction"
},
{
"$ref": "#/components/schemas/CountdownDelayAction"
},
{
"$ref": "#/components/schemas/AbTestAction"
},
{
"$ref": "#/components/schemas/InternalServiceAction"
},
{
"$ref": "#/components/schemas/CodeAction"
},
{
"$ref": "#/components/schemas/MultiBranchSplitAction"
},
{
"$ref": "#/components/schemas/ListUpdateAction"
}
]
},
"updated": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"flow-messages": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchFlowResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"archived": {
"nullable": true,
"type": "boolean"
},
"created": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"trigger_type": {
"description": "Corresponds to the object which triggered the flow.",
"enum": [
"Added to List",
"Date Based",
"Low Inventory",
"Metric",
"Price Drop",
"Unconfigured"
],
"nullable": true,
"type": "string"
},
"updated": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-actions": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchIdentifiers": {
"properties": {
"append": {
"type": "object"
},
"unappend": {
"type": "object"
}
},
"type": "object"
},
"PatchImageResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"format": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"image_url": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
},
"updated_at": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"image_url",
"format",
"size",
"hidden",
"updated_at"
],
"type": "object"
},
"id": {
"description": "The ID of the image",
"example": "7",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchListPartialUpdateResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"name": {
"description": "A helpful name to label the list",
"example": "Newsletter",
"nullable": true,
"type": "string"
},
"opt_in_process": {
"description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
"enum": [
"double_opt_in",
"single_opt_in"
],
"example": "double_opt_in",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchMappedMetricResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"updated": {
"description": "The datetime when this mapping was last updated.",
"example": "2025-04-15T00:00:00Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"updated"
],
"type": "object"
},
"id": {
"description": "The type of mapping.",
"enum": [
"added_to_cart",
"cancelled_sales",
"ordered_product",
"refunded_sales",
"revenue",
"started_checkout",
"viewed_product"
],
"example": "revenue",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"custom-metric": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The ID of the custom metric for this mapping.",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CustomMetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"metric": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The ID of the metric for this mapping.",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/MappedMetricEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchProfileResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"last_event_date": {
"description": "Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"predictive_analytics": {
"$ref": "#/components/schemas/PredictiveAnalytics",
"nullable": true
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"subscriptions": {
"$ref": "#/components/schemas/Subscriptions",
"nullable": true
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"push-tokens": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/PushTokenEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchReviewResponseDTO": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"author": {
"description": "The author of this review",
"example": "John D",
"nullable": true,
"type": "string"
},
"content": {
"description": "The content of this review",
"example": "Great product! I love the smell. I will be buying again.",
"nullable": true,
"type": "string"
},
"created": {
"description": "The datetime when this review was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"email": {
"description": "The email of the author of this review",
"example": "john@doe.com",
"nullable": true,
"type": "string"
},
"images": {
"description": "The list of images submitted with this review (represented as a list of urls). If there are no images, this field will be an empty list.",
"example": [
"https://example.com/image1.jpg",
"https://example.com/image2.jpg"
],
"items": {
"type": "string"
},
"type": "array"
},
"product": {
"$ref": "#/components/schemas/ReviewProductDTO",
"description": "The product associated with this review",
"nullable": true
},
"public_reply": {
"$ref": "#/components/schemas/ReviewPublicReply",
"description": "The public reply to this review (if one exists)",
"nullable": true
},
"rating": {
"description": "The rating of this review on a scale from 1-5. If the review type is \"question\", this field will be null.",
"example": 2,
"nullable": true,
"type": "integer"
},
"review_type": {
"description": "The type of this review \u2014 either a review, question, or rating",
"enum": [
"question",
"rating",
"review",
"store"
],
"example": "review",
"type": "string"
},
"smart_quote": {
"description": "A quote from this review that summarizes the content",
"example": "I love the smell",
"nullable": true,
"type": "string"
},
"status": {
"description": "The status of this review",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReviewStatusRejected"
},
{
"$ref": "#/components/schemas/ReviewStatusFeatured"
},
{
"$ref": "#/components/schemas/ReviewStatusPublished"
},
{
"$ref": "#/components/schemas/ReviewStatusUnpublished"
},
{
"$ref": "#/components/schemas/ReviewStatusPending"
}
]
},
"title": {
"description": "The title of this review",
"example": "Smells great, would recommend",
"nullable": true,
"type": "string"
},
"updated": {
"description": "The datetime when this review was updated",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"verified": {
"description": "The verification status of this review (aka whether or not we have confirmation that the customer bought the product)",
"example": true,
"type": "boolean"
}
},
"required": [
"verified",
"review_type",
"created",
"updated",
"images"
],
"type": "object"
},
"id": {
"description": "The ID of the review",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"events": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Related Events",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/EventEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"item": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Related Catalog Item",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ReviewEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchSegmentPartialUpdateResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/SegmentDefinition",
"nullable": true
},
"is_active": {
"description": "Whether the segment is active. Inactive segments are not processed and their membership does not update.",
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"is_starred": {
"type": "boolean"
},
"name": {
"description": "A helpful name to label the segment",
"example": "Repeat Purchasers",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"is_active",
"is_processing",
"is_starred"
],
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchTemplateDndResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"amp": {
"description": "The AMP version of the template. Requires AMP Email to be enabled to access in-app. Refer to the AMP Email setup guide at https://developers.klaviyo.com/en/docs/send_amp_emails_in_klaviyo",
"nullable": true,
"type": "string"
},
"created": {
"description": "The date the template was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/TemplateDefinition",
"description": "Template definition for SYSTEM_DRAGGABLE templates. Omitted for CODE/USER_DRAGGABLE. Use additional-fields[template]=definition to include in list responses.",
"nullable": true
},
"editor_type": {
"description": "`editor_type` has a fixed set of values:\n* SYSTEM_DRAGGABLE: indicates a drag-and-drop editor template\n* SIMPLE: A rich text editor template\n* CODE: A custom HTML template\n* USER_DRAGGABLE: A hybrid template, using custom HTML in the drag-and-drop editor",
"type": "string"
},
"html": {
"description": "The rendered HTML of the template",
"type": "string"
},
"name": {
"description": "The name of the template",
"type": "string"
},
"text": {
"description": "The template plain_text",
"nullable": true,
"type": "string"
},
"updated": {
"description": "The date the template was updated in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"name",
"editor_type",
"html"
],
"type": "object"
},
"id": {
"description": "The ID of template",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchTrackingSettingResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"auto_add_parameters": {
"description": "Whether tracking parameters are automatically added to campaigns and flows.",
"type": "boolean"
},
"custom_parameters": {
"description": "Additional custom tracking parameters.",
"items": {
"$ref": "#/components/schemas/CustomTrackingParamDTO"
},
"nullable": true,
"type": "array"
},
"utm_campaign": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_campaign tracking parameter.",
"nullable": true
},
"utm_id": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_id tracking parameter.",
"nullable": true
},
"utm_medium": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_medium tracking parameter."
},
"utm_source": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_source tracking parameter."
},
"utm_term": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_term tracking parameter.",
"nullable": true
}
},
"required": [
"auto_add_parameters",
"utm_source",
"utm_medium"
],
"type": "object"
},
"id": {
"description": "The id of the tracking setting (account ID).",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/TrackingSettingEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchUniversalContentResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "The datetime when this universal content was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"definition": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ButtonBlockV0"
},
{
"$ref": "#/components/schemas/CouponBlockV0"
},
{
"$ref": "#/components/schemas/DropShadowBlockV0"
},
{
"$ref": "#/components/schemas/HeaderBlockV0"
},
{
"$ref": "#/components/schemas/HorizontalRuleBlockV0"
},
{
"$ref": "#/components/schemas/HTMLBlockV0"
},
{
"$ref": "#/components/schemas/ImageBlockV0"
},
{
"$ref": "#/components/schemas/ProductBlockV0"
},
{
"$ref": "#/components/schemas/ReviewBlockV0"
},
{
"$ref": "#/components/schemas/SocialBlockV0"
},
{
"$ref": "#/components/schemas/SpacerBlockV0"
},
{
"$ref": "#/components/schemas/SplitBlockV0"
},
{
"$ref": "#/components/schemas/TableBlockV0"
},
{
"$ref": "#/components/schemas/TextBlockV0"
},
{
"$ref": "#/components/schemas/UnsupportedBlock"
},
{
"$ref": "#/components/schemas/VideoBlockV0"
},
{
"$ref": "#/components/schemas/SectionV0"
}
]
},
"name": {
"description": "The name for this universal content",
"type": "string"
},
"screenshot_status": {
"description": "The status of a universal content screenshot.",
"enum": [
"completed",
"failed",
"generating",
"never_generated",
"not_renderable",
"stale"
],
"type": "string"
},
"screenshot_url": {
"type": "string"
},
"updated": {
"description": "The datetime when this universal content was updated",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"created",
"updated",
"screenshot_status",
"screenshot_url"
],
"type": "object"
},
"id": {
"description": "The ID of the universal content",
"example": "01HWWWKAW4RHXQJCMW4R2KRYR4",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/TemplateUniversalContentEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchWebFeedResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"content_type": {
"description": "The content-type of the web feed",
"enum": [
"json",
"xml"
],
"example": "json",
"type": "string"
},
"created": {
"description": "Date and time when the web feed was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"name": {
"description": "The name of this web feed",
"example": "Blog_posts",
"type": "string"
},
"request_method": {
"description": "The HTTP method for requesting the web feed",
"enum": [
"get",
"post"
],
"example": "get",
"type": "string"
},
"status": {
"description": "The cache status of this web feed if it exists",
"enum": [
"critical_nightly_refresh_timeout",
"disabled",
"ok",
"refreshing",
"warning_nightly_refresh_timeout",
"warning_periodic_refresh_timeout"
],
"example": "ok",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the web feed was updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"url": {
"description": "The URL of the web feed",
"example": "https://help.klaviyo.com/api/v2/help_center/en-us/articles.json",
"type": "string"
}
},
"required": [
"name",
"url",
"request_method",
"content_type",
"created",
"updated"
],
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this web feed. Generated by Klaviyo",
"example": "925e385b52fb",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/WebFeedEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PatchWebhookResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created_at": {
"description": "Date and time when the webhook was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T01:23:45+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"description": {
"description": "A description for the webhook.",
"example": "A webhook for sms events",
"nullable": true,
"type": "string"
},
"enabled": {
"description": "Is the webhook enabled.",
"type": "boolean"
},
"endpoint_url": {
"description": "The url to send webhook requests to, truncated for security.",
"example": "https://www.example.com",
"type": "string"
},
"name": {
"description": "A name for the webhook.",
"example": "My Webhook",
"type": "string"
},
"updated_at": {
"description": "Date and time when the webhook was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T01:23:45+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"name",
"endpoint_url",
"enabled"
],
"type": "object"
},
"id": {
"description": "The ID of the webhook.",
"example": "01HF7AYTK76RHR4F17G6DGTRGF",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"webhook-topics": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A topic the webhook is subscribed to.",
"example": "event:klaviyo.sent_sms",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/WebhookTopicEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/WebhookEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PhoneNumber": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/PhoneNumberProperties"
},
"styles": {
"$ref": "#/components/schemas/PhoneNumberStyles"
},
"type": {
"enum": [
"phone_number"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"PhoneNumberConsentChannelSettings": {
"properties": {
"consent_type": {
"description": "Consent Type Enum.",
"enum": [
"phone_number_only",
"promotional",
"transactional"
],
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"PhoneNumberProperties": {
"properties": {
"channel_settings": {
"$ref": "#/components/schemas/ChannelSettings",
"nullable": true
},
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"placeholder": {
"nullable": true,
"type": "string"
},
"property_name": {
"default": "$phone_number",
"example": "$phone_number",
"type": "string"
},
"required": {
"default": false,
"nullable": true,
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
},
"sms_consent_type": {
"items": {
"description": "Consent Type Enum.",
"enum": [
"phone_number_only",
"promotional",
"transactional"
],
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"PhoneNumberStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"PostBulkProfileSuppressionsCreateJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"skipped_count": {
"default": 0,
"description": "The total number of profiles that have been skipped as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Suppress/Unsuppress all profiles in this list",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Suppress/Unsuppress all profiles in this segment",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileSuppressionBulkCreateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostBulkProfileSuppressionsRemoveJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"skipped_count": {
"default": 0,
"description": "The total number of profiles that have been skipped as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Suppress/Unsuppress all profiles in this list",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Suppress/Unsuppress all profiles in this segment",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileSuppressionBulkDeleteJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCampaignMessageResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"channel": {
"description": "The channel the message is to be sent on",
"type": "string"
},
"content": {
"description": "Additional attributes relating to the content of the message",
"oneOf": [
{
"$ref": "#/components/schemas/EmailContentSubObject"
},
{
"$ref": "#/components/schemas/SMSContentSubObject"
}
]
},
"created_at": {
"description": "The datetime when the message was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"label": {
"description": "The label or name on the message",
"type": "string"
},
"render_options": {
"$ref": "#/components/schemas/RenderOptionsSubObject",
"description": "Additional options for rendering the message",
"nullable": true
},
"send_times": {
"description": "The list of appropriate Send Time Sub-objects associated with the message",
"items": {
"$ref": "#/components/schemas/SendTimeSubObject"
},
"nullable": true,
"type": "array"
},
"updated_at": {
"description": "The datetime when the message was last updated",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"label",
"channel",
"content"
],
"type": "object"
},
"id": {
"description": "The message ID",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"campaign": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The parent campaign id",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"template": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The associated template id",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCampaignRecipientEstimationJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"status": {
"description": "The status of the recipient estimation job",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"id": {
"description": "The ID of the campaign used for estimating recipients",
"example": "01GMRWDSA0ARTAKE1SFX8JGXAY",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/CampaignRecipientEstimationJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCampaignResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"archived": {
"description": "Whether the campaign has been archived or not",
"type": "boolean"
},
"audiences": {
"$ref": "#/components/schemas/Audiences",
"description": "The audiences to be included and/or excluded from the campaign"
},
"created_at": {
"description": "The datetime when the campaign was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"name": {
"description": "The campaign name",
"type": "string"
},
"scheduled_at": {
"description": "The datetime when the campaign was scheduled for future sending",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"send_options": {
"description": "Options to use when sending a campaign",
"oneOf": [
{
"$ref": "#/components/schemas/EmailSendOptions"
},
{
"$ref": "#/components/schemas/SMSSendOptions"
},
{
"$ref": "#/components/schemas/PushSendOptions"
}
]
},
"send_strategy": {
"description": "The send strategy the campaign will send with",
"oneOf": [
{
"$ref": "#/components/schemas/StaticSendStrategy"
},
{
"$ref": "#/components/schemas/SmartSendTimeStrategy"
},
{
"$ref": "#/components/schemas/ThrottledSendStrategy"
},
{
"$ref": "#/components/schemas/ImmediateSendStrategy"
},
{
"$ref": "#/components/schemas/ABTestSendStrategy"
},
{
"$ref": "#/components/schemas/UnsupportedSendStrategy"
}
]
},
"send_time": {
"description": "The datetime when the campaign will be / was sent or None if not yet scheduled by a send_job.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "The current status of the campaign",
"enum": [
"Adding Recipients",
"Cancelled",
"Cancelled: Account Disabled",
"Cancelled: Billing Limit",
"Cancelled: Internal Error",
"Cancelled: Misconfigured",
"Cancelled: No Recipients",
"Cancelled: Smart Sending",
"Draft",
"Preparing to schedule",
"Preparing to send",
"Queued without Recipients",
"Scheduled",
"Sending",
"Sending Segments",
"Sent",
"Unknown",
"Variations Sent"
],
"type": "string"
},
"tracking_options": {
"description": "The tracking options associated with the campaign",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CampaignsEmailTrackingOptions"
},
{
"$ref": "#/components/schemas/CampaignsSMSTrackingOptions"
}
]
},
"updated_at": {
"description": "The datetime when the campaign was last updated by a user or the system",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"status",
"archived",
"audiences",
"send_options",
"send_strategy",
"created_at",
"updated_at"
],
"type": "object"
},
"id": {
"description": "The campaign ID",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"campaign-messages": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The message(s) associated with the campaign",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCampaignSendJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"status": {
"description": "The status of the send job",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"type": "string"
}
},
"required": [
"status"
],
"type": "object"
},
"id": {
"description": "The ID of the campaign to send",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/CampaignSendJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCampaignValuesResponseDTO": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"results": {
"description": "An array of all the returned values data.\nEach object in the array represents one unique grouping and the results for that grouping.",
"example": [
{
"groupings": {
"campaign_id": "01GMRWDSA0ARTAKE1SFX8JGXAY",
"campaign_message_id": "01GMRWDSA0ARTAKE1SFX8JGXAY",
"send_channel": "email"
},
"statistics": {
"open_rate": 0.8253,
"opens": 123
}
},
{
"groupings": {
"campaign_id": "01GJTHNWVG93F3KNX71SJ4FDBB",
"campaign_message_id": "01GJTHNWVG93F3KNX71SJ4FDBB",
"send_channel": "email"
},
"statistics": {
"open_rate": 0.7562,
"opens": 97
}
}
],
"items": {
"$ref": "#/components/schemas/ValuesData"
},
"type": "array"
}
},
"required": [
"results"
],
"type": "object"
},
"relationships": {
"properties": {
"campaigns": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CampaignValuesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogCategoryCreateJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the created catalog categories.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryBulkCreateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogCategoryDeleteJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the deleted catalog categories.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryBulkDeleteJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogCategoryResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"external_id": {
"description": "The ID of the catalog category in an external system.",
"example": "SAMPLE-DATA-CATEGORY-APPAREL",
"nullable": true,
"type": "string"
},
"name": {
"description": "The name of the catalog category.",
"example": "Sample Data Category Apparel",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the catalog category was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogCategoryUpdateJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"categories": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the updated catalog categories.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogCategoryBulkUpdateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogItemCreateJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the created catalog items.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemBulkCreateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogItemDeleteJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the deleted catalog items.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemBulkDeleteJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogItemResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the catalog item was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item. May not exceed 100kb.",
"example": {
"Top Pick": true
},
"nullable": true,
"type": "object"
},
"description": {
"description": "A description of the catalog item.",
"example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "The ID of the catalog item in an external system.",
"example": "SAMPLE-DATA-ITEM-1",
"nullable": true,
"type": "string"
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item.",
"example": "https://via.placeholder.com/300",
"nullable": true,
"type": "string"
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item.",
"example": [
"https://via.placeholder.com/150"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"price": {
"description": "This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).",
"example": 42,
"nullable": true,
"type": "number"
},
"published": {
"description": "Boolean value indicating whether the catalog item is published.",
"example": true,
"nullable": true,
"type": "boolean"
},
"title": {
"description": "The title of the catalog item.",
"example": "Ocean Blue Shirt (Sample)",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the catalog item was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"url": {
"description": "URL pointing to the location of the catalog item on your website.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"variants": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogItemUpdateJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"items": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the updated catalog items.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogItemBulkUpdateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogVariantCreateJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"variants": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the created catalog variants.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantBulkCreateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogVariantDeleteJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"variants": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the deleted catalog variants.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantBulkDeleteJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogVariantResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the catalog item variant was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"custom_metadata": {
"description": "Flat JSON blob to provide custom metadata about the catalog item variant. May not exceed 100kb.",
"example": {
"Top Pick": true
},
"nullable": true,
"type": "object"
},
"description": {
"description": "A description of the catalog item variant.",
"example": "Ocean blue cotton shirt with a narrow collar and buttons down the front and long sleeves. Comfortable fit and titled kaleidoscope patterns.",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "The ID of the catalog item variant in an external system.",
"example": "SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"nullable": true,
"type": "string"
},
"image_full_url": {
"description": "URL pointing to the location of a full image of the catalog item variant.",
"example": "https://via.placeholder.com/300",
"nullable": true,
"type": "string"
},
"image_thumbnail_url": {
"description": "URL pointing to the location of an image thumbnail of the catalog item variant.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
},
"images": {
"description": "List of URLs pointing to the locations of images of the catalog item variant.",
"example": [
"https://via.placeholder.com/150"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"inventory_policy": {
"description": "This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values:\n`1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock.\n`0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.",
"enum": [
0,
1,
2
],
"example": 2,
"nullable": true,
"type": "integer"
},
"inventory_quantity": {
"description": "The quantity of the catalog item variant currently in stock.",
"example": 25,
"nullable": true,
"type": "number"
},
"price": {
"description": "This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).",
"example": 42,
"nullable": true,
"type": "number"
},
"published": {
"description": "Boolean value indicating whether the catalog item variant is published.",
"example": true,
"nullable": true,
"type": "boolean"
},
"sku": {
"description": "The SKU of the catalog item variant.",
"example": "OBS-MD",
"nullable": true,
"type": "string"
},
"title": {
"description": "The title of the catalog item variant.",
"example": "Ocean Blue Shirt (Sample) Variant Medium",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the catalog item variant was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"url": {
"description": "URL pointing to the location of the catalog item variant on your website.",
"example": "https://via.placeholder.com/150",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"item": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCatalogVariantUpdateJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"variants": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the updated catalog variants.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantBulkUpdateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCouponCodeCreateJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"errors": {
"description": "Array of errors encountered during the processing of the job.",
"items": {
"$ref": "#/components/schemas/APIJobErrorPayload"
},
"nullable": true,
"type": "array"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"coupon-codes": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the created coupon codes.",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CouponCodeEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CouponCodeBulkCreateJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCouponCodeResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"expires_at": {
"description": "The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "The current status of the coupon code.",
"enum": [
"ASSIGNED_TO_PROFILE",
"DELETING",
"PROCESSING",
"UNASSIGNED",
"USED",
"VERSION_NOT_ACTIVE"
],
"example": "UNASSIGNED",
"nullable": true,
"type": "string"
},
"unique_code": {
"description": "This is a unique string that will be or is assigned to each customer/profile and is associated with a coupon.",
"example": "ASD325FHK324UJDOI2M3JNES99",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"coupon": {
"properties": {
"data": {
"properties": {
"id": {
"example": "10OFF",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CouponEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profile": {
"properties": {
"data": {
"properties": {
"id": {
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CouponCodeEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCouponResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"description": {
"description": "A description of the coupon.",
"example": "10% off for purchases over $50",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "This is the id that is stored in an integration such as Shopify or Magento.",
"example": "10OFF",
"type": "string"
},
"monitor_configuration": {
"description": "The monitor configuration for the coupon.",
"example": {
"low_balance_threshold": 500
},
"nullable": true,
"type": "object"
}
},
"required": [
"external_id"
],
"type": "object"
},
"id": {
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"example": "10OFF",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/CouponEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostCustomMetricResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "The datetime when this custom metric was created.",
"example": "2025-04-15T00:00:00Z",
"format": "date-time",
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/CustomMetricDefinition",
"description": "The definition of a custom metric. It is composed of a list of `metric_groups`. Each group specifies how to query a particular metric with customized filters and the value property to calculate conversion value measurements (if applicable). The groups are combined with `AND` relationships, i.e., conversion and conversion value measurements for each group will be added together to get the final result.",
"example": {
"aggregation_method": "value",
"metric_groups": [
{
"metric_filters": [
{
"filter": {
"operator": "starts-with",
"type": "string",
"value": "some_substring"
},
"property": "my_string_property"
},
{
"filter": {
"operator": "greater-than-or-equal",
"type": "numeric",
"value": 999
},
"property": "my_numeric_property"
}
],
"metric_id": "AAAAAA",
"value_property": "$value"
},
{
"metric_filters": [
{
"filter": {
"operator": "equals",
"type": "boolean",
"value": false
},
"property": "my_boolean_property"
},
{
"filter": {
"operator": "contains",
"type": "list",
"value": "some_value_in_a_list"
},
"property": "my_list_property"
}
],
"metric_id": "BBBBBB",
"value_property": "my_numeric_property"
}
]
}
},
"name": {
"description": "The name for this custom metric. Names must be unique across the account. Attempting to create a metric with a duplicate name will return a 400 status code.",
"example": "My custom metric",
"type": "string"
},
"updated": {
"description": "The datetime when this custom metric was updated.",
"example": "2025-04-15T00:00:00Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"created",
"updated",
"definition"
],
"type": "object"
},
"id": {
"description": "The ID of the custom metric",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"metrics": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Related metrics",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/MetricEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/CustomMetricEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostDataSourceResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"description": {
"description": "The description of the data source",
"example": "This is a data source",
"type": "string"
},
"namespace": {
"description": "The namespace of the data source",
"example": "custom-objects",
"type": "string"
},
"title": {
"description": "The title of the data source",
"example": "My Data Source",
"type": "string"
},
"visibility": {
"description": "The status of the data source",
"enum": [
"private",
"shared"
],
"type": "string"
}
},
"required": [
"title",
"visibility",
"description",
"namespace"
],
"type": "object"
},
"id": {
"description": "The ID of the data source",
"example": "01KH1D6P9Y8TJ7Q6MHXWZMPDN3",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/DataSourceEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostEncodedFormResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"ab_test": {
"description": "Whether the form has an A/B test configured.",
"type": "boolean"
},
"created_at": {
"description": "The ISO8601 timestamp when the form was created.",
"example": "2024-03-04T00:00:00Z",
"format": "date-time",
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/FormDefinition",
"description": "The encoded form definition."
},
"name": {
"description": "The name of the form.",
"example": "Cyber Monday Deals",
"type": "string"
},
"status": {
"description": "The status of the form.",
"enum": [
"draft",
"live"
],
"example": "draft",
"type": "string"
},
"updated_at": {
"description": "The ISO8601 timestamp when the form was last updated.",
"example": "2024-03-04T00:00:00Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"status",
"ab_test",
"name",
"definition",
"created_at",
"updated_at"
],
"type": "object"
},
"id": {
"description": "The ID of the form",
"example": "Y6nRLr",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/FormEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostFlowSeriesResponseDTO": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"date_times": {
"description": "An array of date times which correspond to the equivalent index in the results data.",
"example": [
"2024-01-05T00:00:00+00:00",
"2024-01-06T00:00:00+00:00",
"2024-01-07T00:00:00+00:00"
],
"items": {
"format": "date-time",
"type": "string"
},
"type": "array"
},
"results": {
"description": "An array of all the returned values data.\nEach object in the array represents one unique grouping and the results for that grouping.\nEach value in the results array corresponds to the date time at the same index.",
"example": [
{
"groupings": {
"flow_id": "XVTP5Q",
"flow_message_id": "01GMRWDSA0ARTAKE1SFX8JGXAY",
"send_channel": "email"
},
"statistics": {
"open_rate": [
0.8253,
0.8722,
0.8398
],
"opens": [
123,
156,
144
]
}
},
{
"groupings": {
"flow_id": "XVTP5Q",
"flow_message_id": "01GJTHNWVG93F3KNX71SJ4FDBB",
"send_channel": "email"
},
"statistics": {
"open_rate": [
0.7562,
0.761,
0.688
],
"opens": [
97,
98,
65
]
}
}
],
"items": {
"$ref": "#/components/schemas/SeriesData"
},
"type": "array"
}
},
"required": [
"results",
"date_times"
],
"type": "object"
},
"relationships": {
"properties": {
"flow-messages": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"flows": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowSeriesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostFlowV2Response": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"archived": {
"nullable": true,
"type": "boolean"
},
"created": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/FlowDefinition",
"description": "The encoded flow definition. Unsupported objects (triggers, actions, etc.) will be included but labeled as unsupported.",
"nullable": true
},
"name": {
"nullable": true,
"type": "string"
},
"status": {
"nullable": true,
"type": "string"
},
"trigger_type": {
"description": "Corresponds to the object which triggered the flow.",
"enum": [
"Added to List",
"Date Based",
"Low Inventory",
"Metric",
"Price Drop",
"Unconfigured"
],
"nullable": true,
"type": "string"
},
"updated": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-actions": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowActionEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostFlowValuesResponseDTO": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"results": {
"description": "An array of all the returned values data.\nEach object in the array represents one unique grouping and the results for that grouping.",
"example": [
{
"groupings": {
"flow_id": "XVTP5Q",
"flow_message_id": "01GMRWDSA0ARTAKE1SFX8JGXAY",
"send_channel": "email"
},
"statistics": {
"open_rate": 0.8253,
"opens": 123
}
},
{
"groupings": {
"flow_id": "XVTP5Q",
"flow_message_id": "01GJTHNWVG93F3KNX71SJ4FDBB",
"send_channel": "email"
},
"statistics": {
"open_rate": 0.7562,
"opens": 97
}
}
],
"items": {
"$ref": "#/components/schemas/ValuesData"
},
"type": "array"
}
},
"required": [
"results"
],
"type": "object"
},
"relationships": {
"properties": {
"flow-messages": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowMessageEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"flows": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FlowValuesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostFormSeriesResponseDTO": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"date_times": {
"description": "An array of date times which correspond to the equivalent index in the results data.",
"example": [
"2024-01-05T00:00:00+00:00",
"2024-01-06T00:00:00+00:00",
"2024-01-07T00:00:00+00:00"
],
"items": {
"format": "date-time",
"type": "string"
},
"type": "array"
},
"results": {
"description": "An array of all the returned values data.\nEach object in the array represents one unique grouping and the results for that grouping.\nEach value in the results array corresponds to the date time at the same index.",
"example": [
{
"groupings": {
"form_id": "abc123"
},
"statistics": {
"submits": [
20,
22,
28
],
"viewed_form": [
100,
120,
140
]
}
},
{
"groupings": {
"form_id": "def456"
},
"statistics": {
"submits": [
20,
25,
30
],
"viewed_form": [
200,
300,
400
]
}
}
],
"items": {
"$ref": "#/components/schemas/SeriesData"
},
"type": "array"
}
},
"required": [
"results",
"date_times"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FormSeriesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostFormValuesResponseDTO": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"results": {
"description": "An array of all the returned values data.\nEach object in the array represents one unique grouping and the results for that grouping.",
"example": [
{
"groupings": {
"form_id": "abc123",
"form_version_id": "012tuy"
},
"statistics": {
"submit_rate": 0.1,
"submits": 9,
"viewed_form": 90
}
},
{
"groupings": {
"form_id": "abc123",
"form_version_id": "756ghi"
},
"statistics": {
"submit_rate": 0.1,
"submits": 1,
"viewed_form": 10
}
}
],
"items": {
"$ref": "#/components/schemas/ValuesData"
},
"type": "array"
}
},
"required": [
"results"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/FormValuesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostImageResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"format": {
"type": "string"
},
"hidden": {
"type": "boolean"
},
"image_url": {
"type": "string"
},
"name": {
"type": "string"
},
"size": {
"type": "integer"
},
"updated_at": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"image_url",
"format",
"size",
"hidden",
"updated_at"
],
"type": "object"
},
"id": {
"description": "The ID of the image",
"example": "7",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/ImageEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostListCreateResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the list was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"name": {
"description": "A helpful name to label the list",
"example": "Newsletter",
"nullable": true,
"type": "string"
},
"opt_in_process": {
"description": "The opt-in process for this list. Valid values: 'double_opt_in', 'single_opt_in'.",
"enum": [
"double_opt_in",
"single_opt_in"
],
"example": "double_opt_in",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the list was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostMetricAggregateResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"data": {
"description": "Aggregation result data",
"items": {
"$ref": "#/components/schemas/MetricAggregateRowDTO"
},
"type": "array"
},
"dates": {
"description": "The dates of the query range",
"items": {
"format": "date-time",
"type": "string"
},
"type": "array"
}
},
"required": [
"dates",
"data"
],
"type": "object"
},
"id": {
"description": "Ephemeral ID associated with the aggregation query",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/MetricAggregateEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostProfileImportJobResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"started_at": {
"description": "Date and time the job started processing in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"import-errors": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Errors encountering during import",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ImportErrorEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/OnlyRelatedLinks"
}
},
"type": "object"
},
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "List to add the profiles to",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the created/updated profiles",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileBulkImportJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostProfileMergeResponse": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The ID of the destination profile that was merged into",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostProfileResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"last_event_date": {
"description": "Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"predictive_analytics": {
"$ref": "#/components/schemas/PredictiveAnalytics",
"nullable": true
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"subscriptions": {
"$ref": "#/components/schemas/Subscriptions",
"nullable": true
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"push-tokens": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/PushTokenEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostSegmentCreateResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/SegmentDefinition",
"nullable": true
},
"is_active": {
"description": "Whether the segment is active. Inactive segments are not processed and their membership does not update.",
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"is_starred": {
"type": "boolean"
},
"name": {
"description": "A helpful name to label the segment",
"example": "Repeat Purchasers",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"is_active",
"is_processing",
"is_starred"
],
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostSegmentSeriesResponseDTO": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"date_times": {
"description": "An array of date times which correspond to the equivalent index in the results data.",
"example": [
"2024-01-05T00:00:00+00:00",
"2024-01-06T00:00:00+00:00",
"2024-01-07T00:00:00+00:00"
],
"items": {
"format": "date-time",
"type": "string"
},
"type": "array"
},
"results": {
"description": "An array of all the returned values data.\nEach object in the array represents one unique grouping and the results for that grouping.\nEach value in the results array corresponds to the date time at the same index.",
"example": [
{
"groupings": {
"segment_id": "abc123"
},
"statistics": {
"net_members_changed": [
40,
62,
88
],
"total_members": [
120,
185,
240
]
}
},
{
"groupings": {
"segment_id": "def456"
},
"statistics": {
"net_members_changed": [
36,
66,
86
],
"total_members": [
103,
163,
213
]
}
}
],
"items": {
"$ref": "#/components/schemas/SeriesData"
},
"type": "array"
}
},
"required": [
"results",
"date_times"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SegmentSeriesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostSegmentValuesResponseDTO": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"results": {
"description": "An array of all the returned values data.\nEach object in the array represents one unique grouping and the results for that grouping.",
"example": [
{
"groupings": {
"segment_id": "abc123"
},
"statistics": {
"net_members_changed": 53,
"total_members": 120
}
},
{
"groupings": {
"segment_id": "def123"
},
"statistics": {
"net_members_changed": 113,
"total_members": 250
}
}
],
"items": {
"$ref": "#/components/schemas/ValuesData"
},
"type": "array"
}
},
"required": [
"results"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SegmentValuesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostTagGroupResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"default": {
"description": "Every company automatically has one Default Tag Group. The Default Tag Group cannot be deleted, and no other Default Tag Groups can be created. This value is true for the Default Tag Group and false for all other Tag Groups.",
"type": "boolean"
},
"exclusive": {
"description": "If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.",
"type": "boolean"
},
"name": {
"description": "The Tag Group name",
"example": "My Tag Group",
"type": "string"
}
},
"required": [
"name",
"exclusive",
"default"
],
"type": "object"
},
"id": {
"description": "The Tag Group ID",
"example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/TagGroupEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostTagResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"name": {
"description": "The Tag name",
"example": "My Tag",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"id": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"campaigns": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"flows": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tag-group": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagGroupEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostTemplateDndResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"amp": {
"description": "The AMP version of the template. Requires AMP Email to be enabled to access in-app. Refer to the AMP Email setup guide at https://developers.klaviyo.com/en/docs/send_amp_emails_in_klaviyo",
"nullable": true,
"type": "string"
},
"created": {
"description": "The date the template was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/TemplateDefinition",
"description": "Template definition for SYSTEM_DRAGGABLE templates. Omitted for CODE/USER_DRAGGABLE. Use additional-fields[template]=definition to include in list responses.",
"nullable": true
},
"editor_type": {
"description": "`editor_type` has a fixed set of values:\n* SYSTEM_DRAGGABLE: indicates a drag-and-drop editor template\n* SIMPLE: A rich text editor template\n* CODE: A custom HTML template\n* USER_DRAGGABLE: A hybrid template, using custom HTML in the drag-and-drop editor",
"type": "string"
},
"html": {
"description": "The rendered HTML of the template",
"type": "string"
},
"name": {
"description": "The name of the template",
"type": "string"
},
"text": {
"description": "The template plain_text",
"nullable": true,
"type": "string"
},
"updated": {
"description": "The date the template was updated in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"name",
"editor_type",
"html"
],
"type": "object"
},
"id": {
"description": "The ID of template",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostTemplateResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"amp": {
"description": "The AMP version of the template. Requires AMP Email to be enabled to access in-app. Refer to the AMP Email setup guide at https://developers.klaviyo.com/en/docs/send_amp_emails_in_klaviyo",
"nullable": true,
"type": "string"
},
"created": {
"description": "The date the template was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"editor_type": {
"description": "`editor_type` has a fixed set of values:\n* SYSTEM_DRAGGABLE: indicates a drag-and-drop editor template\n* SIMPLE: A rich text editor template\n* CODE: A custom HTML template\n* USER_DRAGGABLE: A hybrid template, using custom HTML in the drag-and-drop editor",
"type": "string"
},
"html": {
"description": "The rendered HTML of the template",
"type": "string"
},
"name": {
"description": "The name of the template",
"type": "string"
},
"text": {
"description": "The template plain_text",
"nullable": true,
"type": "string"
},
"updated": {
"description": "The date the template was updated in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"name",
"editor_type",
"html"
],
"type": "object"
},
"id": {
"description": "The ID of template",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostUniversalContentResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "The datetime when this universal content was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"definition": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ButtonBlockV0"
},
{
"$ref": "#/components/schemas/CouponBlockV0"
},
{
"$ref": "#/components/schemas/DropShadowBlockV0"
},
{
"$ref": "#/components/schemas/HeaderBlockV0"
},
{
"$ref": "#/components/schemas/HorizontalRuleBlockV0"
},
{
"$ref": "#/components/schemas/HTMLBlockV0"
},
{
"$ref": "#/components/schemas/ImageBlockV0"
},
{
"$ref": "#/components/schemas/ProductBlockV0"
},
{
"$ref": "#/components/schemas/ReviewBlockV0"
},
{
"$ref": "#/components/schemas/SocialBlockV0"
},
{
"$ref": "#/components/schemas/SpacerBlockV0"
},
{
"$ref": "#/components/schemas/SplitBlockV0"
},
{
"$ref": "#/components/schemas/TableBlockV0"
},
{
"$ref": "#/components/schemas/TextBlockV0"
},
{
"$ref": "#/components/schemas/UnsupportedBlock"
},
{
"$ref": "#/components/schemas/VideoBlockV0"
},
{
"$ref": "#/components/schemas/SectionV0"
}
]
},
"name": {
"description": "The name for this universal content",
"type": "string"
},
"screenshot_status": {
"description": "The status of a universal content screenshot.",
"enum": [
"completed",
"failed",
"generating",
"never_generated",
"not_renderable",
"stale"
],
"type": "string"
},
"screenshot_url": {
"type": "string"
},
"updated": {
"description": "The datetime when this universal content was updated",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"created",
"updated",
"screenshot_status",
"screenshot_url"
],
"type": "object"
},
"id": {
"description": "The ID of the universal content",
"example": "01HWWWKAW4RHXQJCMW4R2KRYR4",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/TemplateUniversalContentEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostWebFeedResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"content_type": {
"description": "The content-type of the web feed",
"enum": [
"json",
"xml"
],
"example": "json",
"type": "string"
},
"created": {
"description": "Date and time when the web feed was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"name": {
"description": "The name of this web feed",
"example": "Blog_posts",
"type": "string"
},
"request_method": {
"description": "The HTTP method for requesting the web feed",
"enum": [
"get",
"post"
],
"example": "get",
"type": "string"
},
"status": {
"description": "The cache status of this web feed if it exists",
"enum": [
"critical_nightly_refresh_timeout",
"disabled",
"ok",
"refreshing",
"warning_nightly_refresh_timeout",
"warning_periodic_refresh_timeout"
],
"example": "ok",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the web feed was updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"url": {
"description": "The URL of the web feed",
"example": "https://help.klaviyo.com/api/v2/help_center/en-us/articles.json",
"type": "string"
}
},
"required": [
"name",
"url",
"request_method",
"content_type",
"created",
"updated"
],
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this web feed. Generated by Klaviyo",
"example": "925e385b52fb",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/WebFeedEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PostWebhookResponse": {
"properties": {
"data": {
"properties": {
"attributes": {
"properties": {
"created_at": {
"description": "Date and time when the webhook was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T01:23:45+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"description": {
"description": "A description for the webhook.",
"example": "A webhook for sms events",
"nullable": true,
"type": "string"
},
"enabled": {
"description": "Is the webhook enabled.",
"type": "boolean"
},
"endpoint_url": {
"description": "The url to send webhook requests to, truncated for security.",
"example": "https://www.example.com",
"type": "string"
},
"name": {
"description": "A name for the webhook.",
"example": "My Webhook",
"type": "string"
},
"updated_at": {
"description": "Date and time when the webhook was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T01:23:45+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"name",
"endpoint_url",
"enabled"
],
"type": "object"
},
"id": {
"description": "The ID of the webhook.",
"example": "01HF7AYTK76RHR4F17G6DGTRGF",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"webhook-topics": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A topic the webhook is subscribed to.",
"example": "event:klaviyo.sent_sms",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/WebhookTopicEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/WebhookEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
}
},
"required": [
"data"
],
"type": "object"
},
"PredictiveAnalytics": {
"properties": {
"average_days_between_orders": {
"description": "Average number of days between orders (None if only one order has been placed)",
"example": 189,
"nullable": true,
"type": "number"
},
"average_order_value": {
"description": "Average value of placed orders",
"example": 46.94,
"nullable": true,
"type": "number"
},
"churn_probability": {
"description": "Probability the customer has churned",
"example": 0.89,
"nullable": true,
"type": "number"
},
"expected_date_of_next_order": {
"description": "Expected date of next order, as calculated at the time of their most recent order",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"historic_clv": {
"description": "Total value of all historically placed orders",
"example": 93.87,
"nullable": true,
"type": "number"
},
"historic_number_of_orders": {
"description": "Number of already placed orders",
"example": 2,
"nullable": true,
"type": "number"
},
"predicted_clv": {
"description": "Predicted value of all placed orders in the next 365 days",
"example": 27.24,
"nullable": true,
"type": "number"
},
"predicted_number_of_orders": {
"description": "Predicted number of placed orders in the next 365 days",
"example": 0.54,
"nullable": true,
"type": "number"
},
"ranked_channel_affinity": {
"description": "List of channels ranked by their predicted effectiveness for this profile, with the best channel being listed first at index 0",
"example": [
"sms",
"email",
"push"
],
"items": {
"description": "Enum for channel name return values used in the V3 API for channel affinity for the field `ranked_channel_affinity`.",
"enum": [
"email",
"push",
"sms",
"whatsapp"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"total_clv": {
"description": "Sum of historic and predicted CLV",
"example": 121.11,
"nullable": true,
"type": "number"
}
},
"type": "object"
},
"PreferencePageFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/EqualsStringFilter",
"description": "Optional filter on a specific subscribe page url",
"nullable": true
},
"method": {
"enum": [
"preference_page"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"PreferencePageMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"preference_page"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"PreviouslySubmitted": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/TriggerBaseProperties"
},
"type": {
"enum": [
"previously_submitted"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"PriceDropCondition": {
"properties": {
"field": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
},
"metric_id": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"price-drop-property"
],
"type": "string"
}
},
"required": [
"type",
"metric_id",
"field",
"filter"
],
"type": "object"
},
"PriceDropTrigger": {
"properties": {
"audience": {
"items": {
"description": "The profiles which the price drop trigger applies to.",
"enum": [
"checkout-started",
"viewed"
],
"type": "string"
},
"type": "array"
},
"currency_type": {
"default": "usd",
"description": "Currency type.",
"enum": [
"usd"
],
"example": "usd",
"type": "string"
},
"price_drop_amount_unit": {
"default": "currency",
"description": "Price Drop amount type.",
"enum": [
"currency",
"percent"
],
"example": "currency",
"type": "string"
},
"price_drop_amount_value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
},
"timeframe_days": {
"default": 30,
"example": 30,
"type": "integer"
},
"trigger_filter": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"$ref": "#/components/schemas/PriceDropCondition"
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"type": {
"enum": [
"price-drop"
],
"type": "string"
}
},
"required": [
"type",
"trigger_filter",
"price_drop_amount_value",
"audience"
],
"type": "object"
},
"ProductBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"properties": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticProductBlockProperties"
},
{
"$ref": "#/components/schemas/DynamicProductBlockProperties"
}
]
},
"styles": {
"$ref": "#/components/schemas/ProductBlockStyles"
}
},
"required": [
"properties",
"display_options",
"styles"
],
"type": "object"
},
"ProductBlockStyles": {
"properties": {
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"button_alignment": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"button_background_color": {
"nullable": true,
"type": "string"
},
"button_border_color": {
"nullable": true,
"type": "string"
},
"button_border_radius": {
"nullable": true,
"type": "integer"
},
"button_border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"button_border_width": {
"nullable": true,
"type": "integer"
},
"button_drop_shadow_color": {
"nullable": true,
"type": "string"
},
"button_font_color": {
"nullable": true,
"type": "string"
},
"button_font_family": {
"nullable": true,
"type": "string"
},
"button_font_size": {
"nullable": true,
"type": "integer"
},
"button_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"button_font_weight": {
"nullable": true,
"type": "string"
},
"button_letter_spacing": {
"nullable": true,
"type": "integer"
},
"button_padding_bottom": {
"nullable": true,
"type": "integer"
},
"button_padding_left": {
"nullable": true,
"type": "integer"
},
"button_padding_right": {
"nullable": true,
"type": "integer"
},
"button_padding_top": {
"nullable": true,
"type": "integer"
},
"button_text_decoration": {
"nullable": true,
"type": "string"
},
"description_font_color": {
"nullable": true,
"type": "string"
},
"description_font_family": {
"nullable": true,
"type": "string"
},
"description_font_size": {
"nullable": true,
"type": "integer"
},
"description_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"description_font_weight": {
"nullable": true,
"type": "string"
},
"description_letter_spacing": {
"nullable": true,
"type": "integer"
},
"description_padding_bottom": {
"nullable": true,
"type": "integer"
},
"description_padding_top": {
"nullable": true,
"type": "integer"
},
"description_text_decoration": {
"nullable": true,
"type": "string"
},
"item_border_color": {
"nullable": true,
"type": "string"
},
"item_border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"item_border_width": {
"nullable": true,
"type": "integer"
},
"item_max_height": {
"nullable": true,
"type": "integer"
},
"item_padding_bottom": {
"nullable": true,
"type": "integer"
},
"item_padding_left": {
"nullable": true,
"type": "integer"
},
"item_padding_right": {
"nullable": true,
"type": "integer"
},
"item_padding_top": {
"nullable": true,
"type": "integer"
},
"item_text_alignment": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"layout": {
"description": "Product layout options.",
"enum": [
"horizontal",
"vertical-left-image",
"vertical-right-image"
],
"nullable": true,
"type": "string"
},
"num_columns": {
"nullable": true,
"type": "integer"
},
"num_rows": {
"nullable": true,
"type": "integer"
},
"original_price_font_color": {
"nullable": true,
"type": "string"
},
"original_price_font_family": {
"nullable": true,
"type": "string"
},
"original_price_font_size": {
"nullable": true,
"type": "integer"
},
"original_price_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"original_price_font_weight": {
"nullable": true,
"type": "string"
},
"original_price_text_decoration": {
"nullable": true,
"type": "string"
},
"price_font_color": {
"nullable": true,
"type": "string"
},
"price_font_family": {
"nullable": true,
"type": "string"
},
"price_font_size": {
"nullable": true,
"type": "integer"
},
"price_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"price_font_weight": {
"nullable": true,
"type": "string"
},
"price_letter_spacing": {
"nullable": true,
"type": "integer"
},
"price_padding_bottom": {
"nullable": true,
"type": "integer"
},
"price_padding_top": {
"nullable": true,
"type": "integer"
},
"price_text_decoration": {
"nullable": true,
"type": "string"
},
"rating_font_color": {
"nullable": true,
"type": "string"
},
"rating_font_family": {
"nullable": true,
"type": "string"
},
"rating_font_size": {
"nullable": true,
"type": "integer"
},
"rating_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"rating_font_weight": {
"nullable": true,
"type": "string"
},
"rating_letter_spacing": {
"nullable": true,
"type": "integer"
},
"rating_padding_bottom": {
"nullable": true,
"type": "integer"
},
"rating_padding_top": {
"nullable": true,
"type": "integer"
},
"rating_text_decoration": {
"nullable": true,
"type": "string"
},
"stack_on_mobile": {
"nullable": true,
"type": "boolean"
},
"title_font_color": {
"nullable": true,
"type": "string"
},
"title_font_family": {
"nullable": true,
"type": "string"
},
"title_font_size": {
"nullable": true,
"type": "integer"
},
"title_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"title_font_weight": {
"nullable": true,
"type": "string"
},
"title_letter_spacing": {
"nullable": true,
"type": "integer"
},
"title_padding_bottom": {
"nullable": true,
"type": "integer"
},
"title_padding_top": {
"nullable": true,
"type": "integer"
},
"title_text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ProductBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"type": {
"enum": [
"product"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"ProductBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/ProductBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"subblocks": {
"items": {
"$ref": "#/components/schemas/ProductSubBlock"
},
"nullable": true,
"type": "array"
},
"type": {
"enum": [
"product"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"ProductSubBlock": {
"properties": {
"autogenerate_link": {
"nullable": true,
"type": "boolean"
},
"button_text": {
"nullable": true,
"type": "string"
},
"currency_code": {
"nullable": true,
"type": "string"
},
"description": {
"nullable": true,
"type": "string"
},
"external_id": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"image_url": {
"nullable": true,
"type": "string"
},
"link": {
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"original_price": {
"nullable": true,
"type": "string"
},
"price": {
"nullable": true,
"type": "string"
},
"product_id": {
"nullable": true,
"type": "string"
},
"title": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"product"
],
"type": "string"
},
"url": {
"nullable": true,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ProfileBulkImportJobEnum": {
"enum": [
"profile-bulk-import-job"
],
"type": "string"
},
"ProfileCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ProfileCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ProfileEnum": {
"enum": [
"profile"
],
"type": "string"
},
"ProfileEventTracked": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/ProfileEventTrackedProperties"
},
"type": {
"enum": [
"profile_event_tracked"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"ProfileEventTrackedProperties": {
"properties": {
"metric": {
"default": "",
"nullable": true,
"type": "string"
},
"property_filters": {
"items": {
"$ref": "#/components/schemas/PropertyFilter"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"ProfileHasCustomObjectCondition": {
"properties": {
"filter": {
"$ref": "#/components/schemas/IntegerFilter"
},
"filters": {
"items": {
"$ref": "#/components/schemas/ProfileHasCustomObjectFilter"
},
"type": "array"
},
"object_type_id": {
"type": "string"
},
"object_type_relationship_id": {
"type": "string"
},
"type": {
"enum": [
"profile-has-custom-object"
],
"type": "string"
}
},
"required": [
"type",
"object_type_id",
"object_type_relationship_id",
"filter",
"filters"
],
"type": "object"
},
"ProfileHasCustomObjectFilter": {
"properties": {
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/NumericRangeFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
},
"property_id": {
"type": "integer"
}
},
"required": [
"property_id",
"filter"
],
"type": "object"
},
"ProfileHasGroupMembershipCondition": {
"properties": {
"group_ids": {
"items": {
"type": "string"
},
"type": "array"
},
"is_member": {
"enum": [
true
],
"type": "boolean"
},
"timeframe_filter": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
}
]
},
"type": {
"enum": [
"profile-group-membership"
],
"type": "string"
}
},
"required": [
"type",
"is_member",
"group_ids"
],
"type": "object"
},
"ProfileHasNotReceivedEmailMessageCondition": {
"properties": {
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/AlltimeDateFilter"
},
{
"$ref": "#/components/schemas/InTheLastBaseRelativeDateFilter"
}
]
},
"type": {
"enum": [
"profile-not-sent-email"
],
"type": "string"
}
},
"required": [
"type",
"timeframe_filter"
],
"type": "object"
},
"ProfileHasNotReceivedPushMessageCondition": {
"properties": {
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/AlltimeDateFilter"
},
{
"$ref": "#/components/schemas/InTheLastBaseRelativeDateFilter"
}
]
},
"type": {
"enum": [
"profile-not-sent-push"
],
"type": "string"
}
},
"required": [
"type",
"timeframe_filter"
],
"type": "object"
},
"ProfileHasNotReceivedSmsMessageCondition": {
"properties": {
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/AlltimeDateFilter"
},
{
"$ref": "#/components/schemas/InTheLastBaseRelativeDateFilter"
}
]
},
"type": {
"enum": [
"profile-not-sent-sms"
],
"type": "string"
}
},
"required": [
"type",
"timeframe_filter"
],
"type": "object"
},
"ProfileIdentifierDTOResourceObject": {
"properties": {
"attributes": {
"properties": {
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"nullable": true,
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ProfileImportJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileImportJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ProfileImportJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"profiles": {
"description": "Array of profiles to create or update",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProfileUpsertQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"profiles"
],
"type": "object"
},
"relationships": {
"properties": {
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Optional list to add the profiles to",
"example": "VRgFBd",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileBulkImportJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ProfileImportJobResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"completed_at": {
"description": "Date and time the job was completed in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"completed_count": {
"default": 0,
"description": "The total number of operations that have been completed by the job.",
"example": 9,
"nullable": true,
"type": "integer"
},
"created_at": {
"description": "The date and time the job was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"expires_at": {
"description": "Date and time the job expires in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"failed_count": {
"default": 0,
"description": "The total number of operations that have failed as part of the job.",
"example": 1,
"nullable": true,
"type": "integer"
},
"started_at": {
"description": "Date and time the job started processing in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"status": {
"description": "Status of the asynchronous job.",
"enum": [
"cancelled",
"complete",
"processing",
"queued"
],
"example": "processing",
"type": "string"
},
"total_count": {
"description": "The total number of operations to be processed by the job. See `completed_count` for the job's current progress.",
"example": 10,
"type": "integer"
}
},
"required": [
"status",
"created_at",
"total_count"
],
"type": "object"
},
"id": {
"description": "Unique identifier for retrieving the job. Generated by Klaviyo.",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"import-errors": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Errors encountering during import",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ImportErrorEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/OnlyRelatedLinks"
}
},
"type": "object"
},
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "List to add the profiles to",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "IDs of the created/updated profiles",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileBulkImportJobEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"ProfileLocation": {
"properties": {
"address1": {
"description": "First line of street address",
"example": "89 E 42nd St",
"nullable": true,
"type": "string"
},
"address2": {
"description": "Second line of street address",
"example": "1st floor",
"nullable": true,
"type": "string"
},
"city": {
"description": "City name",
"example": "New York",
"nullable": true,
"type": "string"
},
"country": {
"description": "Country name",
"example": "United States",
"nullable": true,
"type": "string"
},
"ip": {
"description": "IP Address",
"example": "127.0.0.1",
"nullable": true,
"type": "string"
},
"latitude": {
"description": "Latitude coordinate. We recommend providing a precision of four decimal places.",
"example": "40.7128",
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"longitude": {
"description": "Longitude coordinate. We recommend providing a precision of four decimal places.",
"example": "74.0060",
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"region": {
"description": "Region within a country, such as state or province",
"example": "NY",
"nullable": true,
"type": "string"
},
"timezone": {
"description": "Time zone name. We recommend using time zones from the IANA Time Zone Database.",
"example": "America/New_York",
"nullable": true,
"type": "string"
},
"zip": {
"description": "Zip code",
"example": "10017",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ProfileMarketingConsentCondition": {
"properties": {
"consent": {
"oneOf": [
{
"$ref": "#/components/schemas/HasEmailMarketingConsent"
},
{
"$ref": "#/components/schemas/NoEmailMarketingConsent"
},
{
"$ref": "#/components/schemas/HasSMSMarketingConsent"
},
{
"$ref": "#/components/schemas/NoSMSMarketingConsent"
},
{
"$ref": "#/components/schemas/HasPushMarketingConsent"
},
{
"$ref": "#/components/schemas/NoPushMarketingConsent"
}
]
},
"type": {
"enum": [
"profile-marketing-consent"
],
"type": "string"
}
},
"required": [
"type",
"consent"
],
"type": "object"
},
"ProfileMergeEnum": {
"enum": [
"profile-merge"
],
"type": "string"
},
"ProfileMergeQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileMergeQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ProfileMergeQueryResourceObject": {
"properties": {
"id": {
"description": "The ID of the destination profile to merge into",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"relationships": {
"properties": {
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The ID of a source profile to merge into the destination profile",
"example": "01GDDKASAP8TKDDA2GRZDSVP4I",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"required": [
"profiles"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileMergeEnum"
}
},
"required": [
"type",
"id",
"relationships"
],
"type": "object"
},
"ProfileMeta": {
"properties": {
"patch_identifiers": {
"$ref": "#/components/schemas/PatchIdentifiers",
"description": "Specify one or more patch operations to apply to existing identifier data. Currently only `email` is supported, and it is used to add or remove secondary email addresses on a profile.",
"example": {
"append": {
"email": [
"example@test.com",
"another@example.com"
]
}
},
"nullable": true
},
"patch_properties": {
"$ref": "#/components/schemas/ProfileMetaPatchProperties",
"description": "Specify one or more patch operations to apply to existing property data",
"example": {
"append": {
"skus": "92538"
}
},
"nullable": true
}
},
"type": "object"
},
"ProfileMetaPatchProperties": {
"properties": {
"append": {
"description": "Append a simple value or values to this property array",
"example": {
"skus": "92538"
},
"nullable": true,
"type": "object"
},
"unappend": {
"description": "Remove a simple value or values from this property array",
"example": {
"skus": "40571"
},
"nullable": true,
"type": "object"
},
"unset": {
"description": "Remove a key or keys (and their values) completely from properties",
"example": "skus",
"nullable": true,
"oneOf": [
{
"type": "string"
},
{
"items": {
"type": "string"
},
"type": "array"
}
]
}
},
"type": "object"
},
"ProfileMetricFunnelSteps": {
"properties": {
"metric_exists": {
"type": "boolean"
},
"metric_filters": {
"items": {
"$ref": "#/components/schemas/ProfileMetricPropertyFilter"
},
"nullable": true,
"type": "array"
},
"metric_id": {
"type": "string"
}
},
"required": [
"metric_exists",
"metric_id"
],
"type": "object"
},
"ProfileMetricPropertyFilter": {
"properties": {
"filter": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
},
{
"$ref": "#/components/schemas/ListSetFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ListSubstringFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
}
]
},
"property": {
"type": "string"
}
},
"required": [
"property"
],
"type": "object"
},
"ProfileModificationMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"profile_modification"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"ProfileNoGroupMembershipCondition": {
"properties": {
"group_ids": {
"items": {
"type": "string"
},
"type": "array"
},
"is_member": {
"enum": [
false
],
"type": "boolean"
},
"type": {
"enum": [
"profile-group-membership"
],
"type": "string"
}
},
"required": [
"type",
"is_member",
"group_ids"
],
"type": "object"
},
"ProfileNotInFlowCondition": {
"properties": {
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/AlltimeDateFilter"
},
{
"$ref": "#/components/schemas/InTheLastBaseRelativeDateFilter"
}
]
},
"type": {
"enum": [
"profile-not-in-flow"
],
"type": "string"
}
},
"required": [
"type",
"timeframe_filter"
],
"type": "object"
},
"ProfileOperationDelete": {
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"enum": [
"delete"
],
"type": "string"
},
"property_key": {
"type": "string"
}
},
"required": [
"operator",
"property_key"
],
"type": "object"
},
"ProfileOperationUpdateOrCreateBoolean": {
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"enum": [
"create",
"update"
],
"type": "string"
},
"property_key": {
"type": "string"
},
"property_type": {
"enum": [
"boolean"
],
"type": "string"
},
"property_value": {
"type": "boolean"
}
},
"required": [
"operator",
"property_type",
"property_key",
"property_value"
],
"type": "object"
},
"ProfileOperationUpdateOrCreateDate": {
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"enum": [
"create",
"update"
],
"type": "string"
},
"property_key": {
"type": "string"
},
"property_type": {
"enum": [
"date"
],
"type": "string"
},
"property_value": {
"oneOf": [
{
"format": "date",
"type": "string"
},
{
"enum": [
"today"
],
"type": "string"
}
]
}
},
"required": [
"operator",
"property_type",
"property_key",
"property_value"
],
"type": "object"
},
"ProfileOperationUpdateOrCreateList": {
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"enum": [
"create",
"update"
],
"type": "string"
},
"property_key": {
"type": "string"
},
"property_operation": {
"description": "The type of operation to perform on a list property.",
"enum": [
"add",
"remove"
],
"nullable": true,
"type": "string"
},
"property_type": {
"enum": [
"list"
],
"type": "string"
},
"property_value": {
"type": "string"
}
},
"required": [
"operator",
"property_type",
"property_key",
"property_value"
],
"type": "object"
},
"ProfileOperationUpdateOrCreateNumeric": {
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"enum": [
"create",
"update"
],
"type": "string"
},
"property_key": {
"type": "string"
},
"property_type": {
"enum": [
"numeric"
],
"type": "string"
},
"property_value": {
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
}
},
"required": [
"operator",
"property_type",
"property_key",
"property_value"
],
"type": "object"
},
"ProfileOperationUpdateOrCreateString": {
"properties": {
"operator": {
"description": "The type of operation to perform on a profile property.",
"enum": [
"create",
"update"
],
"type": "string"
},
"property_key": {
"type": "string"
},
"property_type": {
"enum": [
"string"
],
"type": "string"
},
"property_value": {
"type": "string"
}
},
"required": [
"operator",
"property_type",
"property_key",
"property_value"
],
"type": "object"
},
"ProfilePartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProfilePartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ProfilePartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/ProfileMeta",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"ProfilePermissionsCondition": {
"properties": {
"channel": {
"description": "Possible channels for profile permissions criterion.",
"enum": [
"whatsapp_marketing",
"whatsapp_transactional"
],
"type": "string"
},
"permission": {
"oneOf": [
{
"$ref": "#/components/schemas/ExplicitlyReachable"
},
{
"$ref": "#/components/schemas/ImplicitlyReachable"
},
{
"$ref": "#/components/schemas/ImplicitlyOrExplicitlyReachable"
},
{
"$ref": "#/components/schemas/ExplicitlyUnreachable"
},
{
"$ref": "#/components/schemas/ImplicitlyUnreachable"
},
{
"$ref": "#/components/schemas/ImplicitlyOrExplicitlyUnreachable"
}
]
},
"type": {
"enum": [
"profile-permissions"
],
"type": "string"
}
},
"required": [
"type",
"permission",
"channel"
],
"type": "object"
},
"ProfilePostalCodeDistanceCondition": {
"properties": {
"country_code": {
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/GreaterThanPositiveNumericFilter"
},
{
"$ref": "#/components/schemas/LessThanPositiveNumericFilter"
}
]
},
"postal_code": {
"type": "string"
},
"type": {
"enum": [
"profile-postal-code-distance"
],
"type": "string"
},
"unit": {
"description": "Units for profile postal code distance conditions.",
"enum": [
"kilometers",
"miles"
],
"type": "string"
}
},
"required": [
"type",
"country_code",
"postal_code",
"unit",
"filter"
],
"type": "object"
},
"ProfilePredictiveAnalyticsChannelAffinityPriorityCondition": {
"properties": {
"dimension": {
"description": "Possible dimension for channel affinity criterion.",
"enum": [
"channel_affinity"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityPriorityFilter"
},
"measurement": {
"enum": [
"priority"
],
"type": "string"
},
"predicted_channel": {
"description": "Possible channels in a channel affinity definition.",
"enum": [
"email",
"push",
"sms",
"whatsapp"
],
"type": "string"
},
"type": {
"enum": [
"profile-predictive-analytics"
],
"type": "string"
}
},
"required": [
"type",
"dimension",
"measurement",
"predicted_channel",
"filter"
],
"type": "object"
},
"ProfilePredictiveAnalyticsChannelAffinityPriorityFilter": {
"properties": {
"operator": {
"enum": [
"equals"
],
"type": "string"
},
"type": {
"enum": [
"numeric"
],
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ProfilePredictiveAnalyticsChannelAffinityRankCondition": {
"properties": {
"dimension": {
"description": "Possible dimension for channel affinity criterion.",
"enum": [
"channel_affinity"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsChannelAffinityRankFilter"
},
"measurement": {
"enum": [
"rank"
],
"type": "string"
},
"predicted_channel": {
"description": "Possible channels in a channel affinity definition.",
"enum": [
"email",
"push",
"sms",
"whatsapp"
],
"type": "string"
},
"type": {
"enum": [
"profile-predictive-analytics"
],
"type": "string"
}
},
"required": [
"type",
"dimension",
"measurement",
"predicted_channel",
"filter"
],
"type": "object"
},
"ProfilePredictiveAnalyticsChannelAffinityRankFilter": {
"properties": {
"operator": {
"oneOf": [
{
"enum": [
"equals"
],
"type": "string"
},
{
"enum": [
"not-equals"
],
"type": "string"
}
]
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"value": {
"description": "Possible rank values in a channel affinity definition.",
"enum": [
"high",
"low",
"medium"
],
"type": "string"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ProfilePredictiveAnalyticsDateCondition": {
"properties": {
"dimension": {
"description": "Dimension for date profile predictive analytics conditions.",
"enum": [
"expected_date_of_next_purchase"
],
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
}
]
},
"type": {
"enum": [
"profile-predictive-analytics"
],
"type": "string"
}
},
"required": [
"dimension",
"filter",
"type"
],
"type": "object"
},
"ProfilePredictiveAnalyticsNumericCondition": {
"properties": {
"dimension": {
"description": "Dimensions for numeric profile predictive analytics conditions.",
"enum": [
"average_days_between_orders",
"average_order_value",
"churn_probability",
"historic_clv",
"historic_number_of_orders",
"predicted_clv",
"predicted_number_of_orders",
"total_clv"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
"type": {
"enum": [
"profile-predictive-analytics"
],
"type": "string"
}
},
"required": [
"type",
"dimension",
"filter"
],
"type": "object"
},
"ProfilePredictiveAnalyticsStringCondition": {
"properties": {
"dimension": {
"description": "Dimension for string profile predictive analytics conditions.",
"enum": [
"predicted_gender"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/ProfilePredictiveAnalyticsStringFilter"
},
"type": {
"enum": [
"profile-predictive-analytics"
],
"type": "string"
}
},
"required": [
"type",
"dimension",
"filter"
],
"type": "object"
},
"ProfilePredictiveAnalyticsStringFilter": {
"properties": {
"operator": {
"oneOf": [
{
"enum": [
"equals"
],
"type": "string"
},
{
"enum": [
"not-equals"
],
"type": "string"
}
]
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"value": {
"description": "Values for profile predictive analytics gender conditions.",
"enum": [
"likely_female",
"likely_male",
"uncertain"
],
"type": "string"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ProfilePropertyCondition": {
"properties": {
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StringOperatorStringFilter"
},
{
"$ref": "#/components/schemas/StringArrayOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/StringPhoneOperatorStringArrayFilter"
},
{
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
{
"$ref": "#/components/schemas/BooleanFilter"
},
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/ListContainsOperatorListContainsFilter"
},
{
"$ref": "#/components/schemas/ListLengthFilter"
},
{
"$ref": "#/components/schemas/ExistenceOperatorExistenceFilter"
}
]
},
"property": {
"type": "string"
},
"type": {
"enum": [
"profile-property"
],
"type": "string"
}
},
"required": [
"type",
"property",
"filter"
],
"type": "object"
},
"ProfilePropertyDateTrigger": {
"properties": {
"date_field_type": {
"enum": [
"profile-property"
],
"type": "string"
},
"date_profile_property": {
"type": "string"
},
"recurrence_frequency": {
"default": "monthly",
"description": "aka RepeatTypes in app and RepeatType in fender.",
"enum": [
"annually",
"monthly",
"never",
"weekly"
],
"example": "monthly",
"type": "string"
},
"timedelta_unit_before_date": {
"default": "weeks",
"description": "See FlowDateTrigger.UNIT_CHOICES in app and CountdownUnit in fender.",
"enum": [
"days",
"months",
"weeks"
],
"example": "weeks",
"type": "string"
},
"timedelta_value_before_date": {
"type": "integer"
},
"timezone": {
"default": "profile",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC",
"profile"
],
"example": "profile",
"type": "string"
},
"trigger_days": {
"items": {
"description": "Days of the week.",
"enum": [
"friday",
"monday",
"saturday",
"sunday",
"thursday",
"tuesday",
"wednesday"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"trigger_time": {
"format": "time",
"type": "string"
},
"type": {
"enum": [
"date"
],
"type": "string"
}
},
"required": [
"type",
"date_field_type",
"date_profile_property",
"timedelta_value_before_date",
"trigger_time"
],
"type": "object"
},
"ProfileRandomSampleCondition": {
"properties": {
"percentage": {
"type": "integer"
},
"type": {
"enum": [
"profile-sample"
],
"type": "string"
}
},
"required": [
"type",
"percentage"
],
"type": "object"
},
"ProfileRegionCondition": {
"properties": {
"in_region": {
"type": "boolean"
},
"region": {
"description": "Regions for profile region conditions.",
"enum": [
"european_union",
"united_states"
],
"type": "string"
},
"type": {
"enum": [
"profile-region"
],
"type": "string"
}
},
"required": [
"type",
"in_region",
"region"
],
"type": "object"
},
"ProfileResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"last_event_date": {
"description": "Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"push-tokens": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/PushTokenEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes",
"links"
],
"type": "object"
},
"ProfileSubscriptionBulkCreateJobEnum": {
"enum": [
"profile-subscription-bulk-create-job"
],
"type": "string"
},
"ProfileSubscriptionBulkDeleteJobEnum": {
"enum": [
"profile-subscription-bulk-delete-job"
],
"type": "string"
},
"ProfileSubscriptionCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"age_gated_date_of_birth": {
"description": "The profile's date of birth. This field is required to update SMS consent for accounts using age-gating: https://help.klaviyo.com/hc/en-us/articles/17252552814875",
"format": "date",
"nullable": true,
"type": "string"
},
"email": {
"description": "The email address relating to the email subscription included in `subscriptions`. If the email channel is omitted from `subscriptions`, this will be set on the profile.",
"example": "matt-kemp@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "The phone number relating to the SMS subscription included in `subscriptions`. If the SMS channel is omitted from `subscriptions`, this will be set on the profile. This must be in E.164 format.",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"subscriptions": {
"$ref": "#/components/schemas/SubscriptionChannels",
"description": "Specifies the channel and message types that the profile will be consented to."
}
},
"required": [
"subscriptions"
],
"type": "object"
},
"id": {
"description": "The ID of the profile to subscribe. If provided, this will be used to perform the lookup.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"nullable": true,
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ProfileSubscriptionDeleteQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"email": {
"description": "The email address to unsubscribe.",
"example": "matt-kemp@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "The phone number to unsubscribe. This must be in E.164 format.",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"subscriptions": {
"$ref": "#/components/schemas/UnsubscriptionChannels",
"description": "Specifies the channel and message types that the profile will have consent revoked from."
}
},
"required": [
"subscriptions"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ProfileSuppressionBulkCreateJobEnum": {
"enum": [
"profile-suppression-bulk-create-job"
],
"type": "string"
},
"ProfileSuppressionBulkDeleteJobEnum": {
"enum": [
"profile-suppression-bulk-delete-job"
],
"type": "string"
},
"ProfileSuppressionCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"email": {
"description": "The email of the profile to suppress.",
"example": "matt-kemp@klaviyo-demo.com",
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ProfileSuppressionDeleteQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"email": {
"description": "The email of the profile to unsuppress.",
"example": "matt-kemp@klaviyo-demo.com",
"type": "string"
}
},
"required": [
"email"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ProfileUpsertQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileUpsertQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ProfileUpsertQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"_kx": {
"description": "Also known as the `exchange_id`, this is an encrypted identifier used for identifying a\nprofile by Klaviyo's web tracking.\n\nYou can use this field as a filter when retrieving profiles via the Get Profiles endpoint.",
"nullable": true,
"type": "string"
},
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"nullable": true,
"type": "string"
},
"meta": {
"$ref": "#/components/schemas/ProfileMeta",
"nullable": true
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ProfileUpsertQueryWithSubscriptionsResourceObject": {
"properties": {
"attributes": {
"properties": {
"_kx": {
"description": "Also known as the `exchange_id`, this is an encrypted identifier used for identifying a\nprofile by Klaviyo's web tracking.\n\nYou can use this field as a filter when retrieving profiles via the Get Profiles endpoint.",
"nullable": true,
"type": "string"
},
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"meta": {
"$ref": "#/components/schemas/ProfileMeta",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"subscriptions": {
"$ref": "#/components/schemas/SubscriptionChannels",
"nullable": true
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"nullable": true,
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"PromotionalSMSSubscription": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"enum": [
null
]
},
"submit": {
"default": true,
"enum": [
true
],
"example": true,
"type": "boolean"
},
"type": {
"enum": [
"promotional_sms_subscription"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Property": {
"properties": {
"badge_config": {
"enum": [
"set_property"
],
"type": "string"
},
"set_from_property": {
"type": "string"
}
},
"required": [
"badge_config",
"set_from_property"
],
"type": "object"
},
"PropertyFilter": {
"properties": {
"property": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"property",
"value"
],
"type": "object"
},
"PropertyOption": {
"properties": {
"label": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"label",
"value"
],
"type": "object"
},
"ProvidedLandlineMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"provided_landline"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"ProvidedNoAgeMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"provided_no_age"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"PushActionButton": {
"properties": {
"action_type": {
"description": "The action type for a push notification action button.",
"enum": [
"deep_link",
"dismiss",
"open_app",
"open_url"
],
"type": "string"
},
"custom_action_id": {
"nullable": true,
"type": "string"
},
"icon": {
"nullable": true,
"type": "string"
},
"label": {
"type": "string"
},
"position": {
"nullable": true,
"type": "integer"
},
"url": {
"nullable": true,
"type": "string"
}
},
"required": [
"label",
"action_type"
],
"type": "object"
},
"PushActionButtonDefinition": {
"properties": {
"action_type": {
"description": "The action type: open_app, deep_link, open_url, or dismiss",
"type": "string"
},
"label": {
"description": "The button label (max 40 characters)",
"type": "string"
},
"position": {
"description": "The display order of the button (0-indexed). If omitted, inferred from the button's order in the list.",
"nullable": true,
"type": "integer"
},
"url": {
"description": "URL for deep_link or open_url action types (max 2048 characters)",
"nullable": true,
"type": "string"
}
},
"required": [
"label",
"action_type"
],
"type": "object"
},
"PushChannel": {
"properties": {
"marketing": {
"$ref": "#/components/schemas/PushMarketing",
"description": "The mobile push marketing subscription.",
"nullable": true
}
},
"type": "object"
},
"PushMarketing": {
"properties": {
"can_receive_push_marketing": {
"description": "Whether or not this profile is subscribed to receive mobile push.",
"type": "boolean"
},
"consent": {
"description": "The consent status for mobile push marketing.",
"example": "SUBSCRIBED",
"type": "string"
},
"consent_timestamp": {
"description": "The timestamp when the consent was last changed, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"can_receive_push_marketing",
"consent"
],
"type": "object"
},
"PushOnOpenApp": {
"properties": {
"type": {
"enum": [
"open_app"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"PushOnOpenDeepLink": {
"properties": {
"android_deep_link": {
"description": "required for all platforms enabled for push",
"nullable": true,
"type": "string"
},
"ios_deep_link": {
"description": "required for all platforms enabled for push",
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"deep_link"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"PushOnOpenWebUrl": {
"properties": {
"type": {
"enum": [
"open_web_url"
],
"type": "string"
},
"web_url": {
"description": "External url to open when push notification is triggered",
"nullable": true,
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"PushProfileUpsertQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"_kx": {
"description": "Also known as the `exchange_id`, this is an encrypted identifier used for identifying a\nprofile by Klaviyo's web tracking.\n\nYou can use this field as a filter when retrieving profiles via the Get Profiles endpoint.",
"nullable": true,
"type": "string"
},
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"meta": {
"$ref": "#/components/schemas/ProfileMeta",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"nullable": true,
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"PushSendOptions": {
"properties": {
"use_smart_sending": {
"default": true,
"description": "Use smart sending.",
"example": true,
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"PushSubscriptionParameters": {
"properties": {
"anonymous_id": {
"description": "An anonymous identifier for push-only profiles with no email/phone.",
"nullable": true,
"type": "string"
},
"marketing": {
"$ref": "#/components/schemas/SubscriptionParameters",
"description": "The parameters to subscribe to marketing on the \"Push\" channel."
},
"tokens": {
"description": "A list of push tokens to register for this profile.",
"items": {
"$ref": "#/components/schemas/PushTokenEntry"
},
"nullable": true,
"type": "array"
}
},
"required": [
"marketing"
],
"type": "object"
},
"PushTokenCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/PushTokenCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"PushTokenCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"background": {
"default": "AVAILABLE",
"description": "The background state of the push token.",
"enum": [
"AVAILABLE",
"DENIED",
"RESTRICTED"
],
"example": "AVAILABLE",
"nullable": true,
"type": "string"
},
"device_metadata": {
"$ref": "#/components/schemas/DeviceMetadata",
"description": "Metadata about the device that created the push token",
"nullable": true
},
"enablement_status": {
"default": "AUTHORIZED",
"description": "This is the enablement status for the individual push token.",
"enum": [
"AUTHORIZED",
"DENIED",
"NOT_DETERMINED",
"PROVISIONAL",
"UNAUTHORIZED"
],
"example": "AUTHORIZED",
"nullable": true,
"type": "string"
},
"platform": {
"description": "The platform on which the push token was created.",
"enum": [
"android",
"ios"
],
"type": "string"
},
"profile": {
"description": "The profile associated with the push token to create/update",
"properties": {
"data": {
"$ref": "#/components/schemas/PushProfileUpsertQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"token": {
"description": "A push token from APNS or FCM.",
"example": "1234567890",
"type": "string"
},
"vendor": {
"description": "The vendor of the push token.",
"enum": [
"apns",
"fcm"
],
"example": "apns",
"type": "string"
}
},
"required": [
"token",
"platform",
"vendor",
"profile"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/PushTokenEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"PushTokenDeviceMetadata": {
"properties": {
"app_build": {
"description": "The build of the app that created the push token",
"example": "1",
"nullable": true,
"type": "string"
},
"app_id": {
"description": "The ID of the app that created the push token",
"example": "com.klaviyo.app",
"nullable": true,
"type": "string"
},
"app_name": {
"description": "The name of the app that created the push token",
"example": "Klaviyo",
"nullable": true,
"type": "string"
},
"app_version": {
"description": "The version of the app that created the push token",
"example": "1.0.0",
"nullable": true,
"type": "string"
},
"device_id": {
"description": "Relatively stable ID for the device. Will update on app uninstall and reinstall",
"example": "1234567890",
"nullable": true,
"type": "string"
},
"device_model": {
"description": "The model of the device",
"example": "iPhone12,1",
"nullable": true,
"type": "string"
},
"environment": {
"description": "The environment in which the push token was created",
"enum": [
"debug",
"release"
],
"example": "release",
"nullable": true,
"type": "string"
},
"klaviyo_sdk": {
"description": "The name of the SDK used to create the push token.",
"enum": [
"android",
"flutter",
"flutter_community",
"react_native",
"swift"
],
"example": "swift",
"nullable": true,
"type": "string"
},
"manufacturer": {
"description": "The manufacturer of the device",
"example": "Apple",
"nullable": true,
"type": "string"
},
"os_name": {
"description": "The name of the operating system on the device.",
"enum": [
"android",
"ios",
"ipados",
"macos",
"tvos"
],
"example": "ios",
"nullable": true,
"type": "string"
},
"os_version": {
"description": "The version of the operating system on the device",
"example": "14.0",
"nullable": true,
"type": "string"
},
"sdk_version": {
"description": "The version of the SDK used to create the push token",
"example": "1.0.0",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"PushTokenEntry": {
"properties": {
"background": {
"description": "The background state of the push token.",
"enum": [
"AVAILABLE",
"DENIED",
"RESTRICTED"
],
"example": "AVAILABLE",
"nullable": true,
"type": "string"
},
"device_metadata": {
"$ref": "#/components/schemas/PushTokenDeviceMetadata",
"description": "Metadata about the device that created the push token.",
"nullable": true
},
"enablement_status": {
"description": "The enablement status for the push token.",
"enum": [
"AUTHORIZED",
"DENIED",
"NOT_DETERMINED",
"PROVISIONAL",
"UNAUTHORIZED"
],
"example": "AUTHORIZED",
"nullable": true,
"type": "string"
},
"platform": {
"description": "The platform on which the push token was created. Either \"ios\" or \"android\".",
"enum": [
"android",
"ios"
],
"type": "string"
},
"token": {
"description": "A push token from APNS or FCM.",
"example": "1234567890abcdef",
"type": "string"
},
"vendor": {
"description": "The vendor of the push token. Either \"apns\" or \"fcm\".",
"enum": [
"apns",
"fcm"
],
"example": "apns",
"type": "string"
}
},
"required": [
"token",
"platform",
"vendor"
],
"type": "object"
},
"PushTokenEnum": {
"enum": [
"push-token"
],
"type": "string"
},
"PushTokenResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"background": {
"description": "The background state of the push token",
"type": "string"
},
"created": {
"description": "The time at which the token was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"enablement_status": {
"description": "The enablement status of the push token",
"enum": [
"AUTHORIZED",
"DENIED",
"NOT_DETERMINED",
"PROVISIONAL",
"UNAUTHORIZED"
],
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/DeviceMetadata",
"description": "Metadata of device",
"nullable": true
},
"platform": {
"description": "The platform of the push token('ios', 'android')",
"enum": [
"android",
"ios"
],
"type": "string"
},
"recorded_date": {
"description": "The date the push token was recorded",
"type": "string"
},
"token": {
"description": "The push token",
"type": "string"
},
"vendor": {
"description": "The vendor of the push token('APNs', 'FCM')",
"type": "string"
}
},
"required": [
"created",
"token",
"enablement_status",
"platform",
"vendor",
"background",
"recorded_date"
],
"type": "object"
},
"id": {
"description": "ID of push token",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"profile": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The profile associated with the push token",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/PushTokenEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"PushTokenUnregisterEnum": {
"enum": [
"push-token-unregister"
],
"type": "string"
},
"PushTokenUnregisterQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/PushTokenUnregisterQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"PushTokenUnregisterQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"platform": {
"description": "The platform on which the push token was created.",
"enum": [
"android",
"ios"
],
"type": "string"
},
"profile": {
"description": "The profile associated with the push token to create/update",
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileUpsertQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"token": {
"description": "A push token from APNS or FCM.",
"example": "1234567890",
"type": "string"
},
"vendor": {
"description": "The vendor of the push token.",
"enum": [
"apns",
"fcm"
],
"example": "apns",
"nullable": true,
"type": "string"
}
},
"required": [
"token",
"platform",
"profile"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/PushTokenUnregisterEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"PushUnsubscriptionParameters": {
"properties": {
"marketing": {
"$ref": "#/components/schemas/UnsubscriptionParameters",
"description": "The parameters to unsubscribe from marketing on the \"Push\" channel."
},
"tokens": {
"description": "A list of push tokens to unsubscribe/remove.",
"items": {
"$ref": "#/components/schemas/PushTokenEntry"
},
"type": "array"
}
},
"required": [
"marketing",
"tokens"
],
"type": "object"
},
"QuoteStyle": {
"properties": {
"alignment": {
"default": "center",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "center",
"type": "string"
},
"character_spacing": {
"default": 0,
"type": "integer"
},
"font_family": {
"default": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"example": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"type": "string"
},
"font_size": {
"default": 16,
"example": 16,
"type": "integer"
},
"font_weight": {
"default": 400,
"example": 400,
"type": "integer"
},
"line_height": {
"default": 1.5,
"example": 1.5,
"type": "number"
},
"text_color": {
"default": "#000000",
"example": "#000000",
"type": "string"
}
},
"type": "object"
},
"RadioButtons": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/RadioButtonsProperties"
},
"styles": {
"$ref": "#/components/schemas/RadioButtonsStyles"
},
"type": {
"enum": [
"radio_buttons"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"RadioButtonsProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"options": {
"items": {
"$ref": "#/components/schemas/PropertyOption"
},
"type": "array"
},
"placeholder": {
"nullable": true,
"type": "string"
},
"property_name": {
"type": "string"
},
"required": {
"default": false,
"nullable": true,
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
}
},
"required": [
"property_name",
"options"
],
"type": "object"
},
"RadioButtonsStyles": {
"properties": {
"alignment": {
"default": "left",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "left",
"type": "string"
},
"arrangement": {
"default": "vertical",
"description": "Arrangement enumeration.",
"enum": [
"horizontal",
"vertical"
],
"example": "vertical",
"type": "string"
},
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"RatingStyle": {
"properties": {
"alignment": {
"default": "center",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "center",
"type": "string"
},
"character_spacing": {
"default": 0,
"type": "number"
},
"color": {
"default": "#F8BE00",
"example": "#F8BE00",
"type": "string"
},
"empty_color": {
"default": "#EBEEEF",
"example": "#EBEEEF",
"type": "string"
},
"font_size": {
"default": 16,
"example": 16,
"type": "integer"
},
"shape": {
"default": "star",
"description": "Enumeration for review shapes.",
"enum": [
"circle",
"heart",
"star"
],
"example": "star",
"type": "string"
}
},
"type": "object"
},
"RecordedDateFilter": {
"properties": {
"field": {
"enum": [
"recorded_date"
],
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
}
]
}
},
"required": [
"field",
"filter"
],
"type": "object"
},
"Redirect": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/RedirectProperties"
},
"submit": {
"type": "boolean"
},
"type": {
"enum": [
"redirect"
],
"type": "string"
}
},
"required": [
"submit",
"type",
"properties"
],
"type": "object"
},
"RedirectProperties": {
"properties": {
"list_id": {
"nullable": true,
"type": "string"
},
"new_window": {
"default": false,
"type": "boolean"
},
"url": {
"default": "",
"type": "string"
}
},
"type": "object"
},
"ReentryCriteria": {
"properties": {
"duration": {
"type": "integer"
},
"unit": {
"oneOf": [
{
"description": "Units for relative date filters.",
"enum": [
"day",
"hour",
"week"
],
"type": "string"
},
{
"description": "Operators for alltime date filters.",
"enum": [
"alltime"
],
"type": "string"
}
]
}
},
"required": [
"duration",
"unit"
],
"type": "object"
},
"RejectReasonFake": {
"properties": {
"reason": {
"description": "rejected due to fake content",
"enum": [
"fake"
],
"type": "string"
}
},
"required": [
"reason"
],
"type": "object"
},
"RejectReasonMisleading": {
"properties": {
"reason": {
"description": "rejected due to false or misleading content",
"enum": [
"false_or_misleading"
],
"type": "string"
}
},
"required": [
"reason"
],
"type": "object"
},
"RejectReasonOther": {
"properties": {
"reason": {
"description": "reject reason is other",
"enum": [
"other"
],
"type": "string"
},
"status_explanation": {
"description": "If review reject reason is other, we can provide further explanation",
"example": "This review is just really poorly detailed and there is another with the same content",
"nullable": true,
"type": "string"
}
},
"required": [
"reason"
],
"type": "object"
},
"RejectReasonPrivateInformation": {
"properties": {
"reason": {
"description": "rejected due to private information",
"enum": [
"private_information"
],
"type": "string"
}
},
"required": [
"reason"
],
"type": "object"
},
"RejectReasonProfanity": {
"properties": {
"reason": {
"description": "rejected due to profanity or inappropriate content",
"enum": [
"profanity_or_inappropriate"
],
"type": "string"
}
},
"required": [
"reason"
],
"type": "object"
},
"RejectReasonUnrelated": {
"properties": {
"reason": {
"description": "rejected due to unrelated content",
"enum": [
"unrelated"
],
"type": "string"
}
},
"required": [
"reason"
],
"type": "object"
},
"RelationshipLinks": {
"properties": {
"related": {
"format": "uri",
"type": "string"
},
"self": {
"format": "uri",
"type": "string"
}
},
"required": [
"self",
"related"
],
"type": "object"
},
"RelativeAnniversaryDateFilter": {
"properties": {
"operator": {
"description": "Operators for relative date filters.\n\ne.g. \"anniversary in the last 10 days\"",
"enum": [
"anniversary-last",
"anniversary-next"
],
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"enum": [
"date"
],
"type": "string"
},
"unit": {
"description": "Units for relative date filters.",
"enum": [
"day",
"hour",
"week"
],
"type": "string"
}
},
"required": [
"type",
"operator",
"unit",
"quantity"
],
"type": "object"
},
"RelativeDateOperatorBaseRelativeDateFilter": {
"properties": {
"operator": {
"description": "Operators for relative date filters.\n\ne.g. \"in the last 10 days\"",
"enum": [
"at-least",
"in-the-last",
"in-the-next"
],
"type": "string"
},
"quantity": {
"type": "integer"
},
"type": {
"enum": [
"date"
],
"type": "string"
},
"unit": {
"description": "Units for relative date filters.",
"enum": [
"day",
"hour",
"week"
],
"type": "string"
}
},
"required": [
"type",
"operator",
"unit",
"quantity"
],
"type": "object"
},
"RelativeDateRangeFilter": {
"properties": {
"end": {
"type": "integer"
},
"operator": {
"description": "Operators for relative date range filters.\n\ne.g. \"between 10 and 20 days ago\"",
"enum": [
"between"
],
"type": "string"
},
"start": {
"type": "integer"
},
"type": {
"enum": [
"date"
],
"type": "string"
},
"unit": {
"description": "Units for relative date filters.",
"enum": [
"day",
"hour",
"week"
],
"type": "string"
}
},
"required": [
"type",
"operator",
"start",
"end",
"unit"
],
"type": "object"
},
"RenderOptions": {
"properties": {
"add_info_link": {
"default": true,
"example": true,
"nullable": true,
"type": "boolean"
},
"add_opt_out_language": {
"default": false,
"nullable": true,
"type": "boolean"
},
"add_org_prefix": {
"default": true,
"example": true,
"nullable": true,
"type": "boolean"
},
"shorten_links": {
"default": true,
"example": true,
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"RenderOptionsSubObject": {
"properties": {
"add_info_link": {
"default": true,
"example": true,
"nullable": true,
"type": "boolean"
},
"add_opt_out_language": {
"default": false,
"nullable": true,
"type": "boolean"
},
"add_org_prefix": {
"default": true,
"example": true,
"nullable": true,
"type": "boolean"
},
"shorten_links": {
"default": true,
"example": true,
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"ResendOptInCode": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"enum": [
null
]
},
"submit": {
"default": false,
"enum": [
false
],
"type": "boolean"
},
"type": {
"enum": [
"resend_opt_in_code"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"Review": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/ReviewProperties"
},
"styles": {
"$ref": "#/components/schemas/ReviewStyles"
},
"type": {
"enum": [
"review"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"ReviewBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"properties": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticReviewBlockProperties"
},
{
"$ref": "#/components/schemas/DynamicReviewBlockProperties"
}
]
},
"styles": {
"$ref": "#/components/schemas/ReviewBlockStyles"
}
},
"required": [
"properties",
"display_options",
"styles"
],
"type": "object"
},
"ReviewBlockStyles": {
"properties": {
"author_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"author_color": {
"nullable": true,
"type": "string"
},
"author_font_family": {
"nullable": true,
"type": "string"
},
"author_font_size": {
"nullable": true,
"type": "integer"
},
"author_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"author_font_weight": {
"nullable": true,
"type": "string"
},
"author_letter_spacing": {
"nullable": true,
"type": "integer"
},
"author_text_decoration": {
"nullable": true,
"type": "string"
},
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"border_radius": {
"nullable": true,
"type": "integer"
},
"border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"border_width": {
"nullable": true,
"type": "integer"
},
"empty_star_color": {
"nullable": true,
"type": "string"
},
"layout": {
"description": "Review block layout options.",
"enum": [
"big-quotes",
"centered-in-quote-bubble",
"centered-rating-first",
"centered-review-first",
"clean",
"left-aligned",
"message-bubble",
"rating-highlight",
"right-aligned-with-quotation-icon",
"square",
"stacked-card",
"subtle-background"
],
"nullable": true,
"type": "string"
},
"product_name_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"product_name_color": {
"nullable": true,
"type": "string"
},
"product_name_font_family": {
"nullable": true,
"type": "string"
},
"product_name_font_size": {
"nullable": true,
"type": "integer"
},
"product_name_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"product_name_font_weight": {
"nullable": true,
"type": "string"
},
"product_name_letter_spacing": {
"nullable": true,
"type": "integer"
},
"product_name_text_decoration": {
"nullable": true,
"type": "string"
},
"quote_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"quote_color": {
"nullable": true,
"type": "string"
},
"quote_font_family": {
"nullable": true,
"type": "string"
},
"quote_font_size": {
"nullable": true,
"type": "integer"
},
"quote_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"quote_font_weight": {
"nullable": true,
"type": "string"
},
"quote_letter_spacing": {
"nullable": true,
"type": "integer"
},
"quote_line_height": {
"nullable": true,
"type": "number"
},
"quote_style": {
"description": "Review block quote style.",
"enum": [
"line",
"square",
"standard"
],
"nullable": true,
"type": "string"
},
"quote_text_decoration": {
"nullable": true,
"type": "string"
},
"shadow_color": {
"nullable": true,
"type": "string"
},
"star_alignment": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"star_color": {
"nullable": true,
"type": "string"
},
"star_icon_spacing": {
"nullable": true,
"type": "integer"
},
"star_rating_shape": {
"description": "Review block star rating shape.",
"enum": [
"circle",
"heart",
"star"
],
"nullable": true,
"type": "string"
},
"star_size": {
"description": "Review block star size.",
"enum": [
"large",
"medium",
"small"
],
"nullable": true,
"type": "string"
},
"text_area_bg_color": {
"nullable": true,
"type": "string"
},
"text_area_border_color": {
"nullable": true,
"type": "string"
},
"verified_badge_color": {
"description": "Review block verified badge color.",
"enum": [
"dark",
"default",
"light"
],
"nullable": true,
"type": "string"
},
"verified_badge_size": {
"nullable": true,
"type": "integer"
},
"verified_badge_style": {
"description": "Review block verified badge style.",
"enum": [
"badge-and-text",
"badge-only",
"text-only"
],
"nullable": true,
"type": "string"
},
"verified_color": {
"nullable": true,
"type": "string"
},
"verified_font_family": {
"nullable": true,
"type": "string"
},
"verified_font_size": {
"nullable": true,
"type": "integer"
},
"verified_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"verified_font_weight": {
"nullable": true,
"type": "string"
},
"verified_letter_spacing": {
"nullable": true,
"type": "integer"
},
"verified_text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"ReviewBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"type": {
"enum": [
"review"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"ReviewBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/ReviewBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"review"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"ReviewCreateDTO": {
"properties": {
"data": {
"$ref": "#/components/schemas/ReviewCreateDTOResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ReviewCreateDTOResourceObject": {
"properties": {
"attributes": {
"properties": {
"author": {
"description": "The author of this review",
"example": "John Doe",
"type": "string"
},
"content": {
"description": "The content of this review",
"example": "This was an absolutely amazing t-shirt. I loved the color and the fit.",
"type": "string"
},
"custom_questions": {
"description": "Custom question and answers for the review",
"example": [
{
"answers": [
"M",
"L"
],
"id": "9ff0d32e-0edb-4513-a6a5-12814a6cb755"
}
],
"items": {
"$ref": "#/components/schemas/CustomQuestionDTO"
},
"nullable": true,
"type": "array"
},
"email": {
"description": "The email of the author of this review",
"example": "random.123@gmail.com",
"type": "string"
},
"images": {
"description": "The list of images submitted with this review (represented as a list of urls or base-64 encoded data-uri). If there are no images, this field will be an empty list.",
"example": [
"https://example.com/image1.jpg",
"https://example.com/image2.jpg"
],
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"incentive_type": {
"description": "The incentive type for the review",
"enum": [
"coupon_or_discount",
"employee_review",
"free_product",
"loyalty_points",
"other",
"paid_promotion",
"sweepstakes_entry"
],
"nullable": true,
"type": "string"
},
"product": {
"$ref": "#/components/schemas/ReviewProductExternalId",
"description": "The product associated with this review",
"nullable": true
},
"rating": {
"description": "The rating of this review on a scale from 1-5. If the review type is \"question\", this field will be null.",
"enum": [
1,
2,
3,
4,
5
],
"example": 2,
"nullable": true,
"type": "integer"
},
"review_type": {
"description": "The type of this review -- either a review or a question",
"enum": [
"question",
"rating",
"review",
"store"
],
"example": "review",
"type": "string"
},
"title": {
"description": "The title of this review",
"example": "Great product!",
"nullable": true,
"type": "string"
}
},
"required": [
"review_type",
"email",
"author",
"content"
],
"type": "object"
},
"relationships": {
"properties": {
"order": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The Order ID related to the review",
"example": "42439497119686",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/OrderEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ReviewEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"ReviewEnum": {
"enum": [
"review"
],
"type": "string"
},
"ReviewPatchQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ReviewPatchQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ReviewPatchQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"status": {
"description": "The updated status intended for the review with this ID",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReviewStatusRejected"
},
{
"$ref": "#/components/schemas/ReviewStatusFeatured"
},
{
"$ref": "#/components/schemas/ReviewStatusPublished"
},
{
"$ref": "#/components/schemas/ReviewStatusUnpublished"
},
{
"$ref": "#/components/schemas/ReviewStatusPending"
}
]
}
},
"type": "object"
},
"id": {
"description": "The id of the review (review ID).",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ReviewEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"ReviewProductDTO": {
"properties": {
"external_id": {
"description": "The external ID of the product",
"example": "123456789",
"nullable": true,
"type": "string"
},
"image_url": {
"description": "The URL of the product image",
"example": "https://example.com/image.jpg",
"nullable": true,
"type": "string"
},
"name": {
"description": "The name of the product",
"type": "string"
},
"url": {
"description": "The URL of the product",
"example": "https://example.com/product/123",
"type": "string"
}
},
"required": [
"url",
"name"
],
"type": "object"
},
"ReviewProductExternalId": {
"properties": {
"external_id": {
"description": "The external ID of the product",
"example": "7549950034135",
"type": "string"
},
"integration_key": {
"description": "The integration key of the product in lowercase",
"enum": [
"shopify",
"woocommerce"
],
"example": "shopify",
"type": "string"
}
},
"required": [
"external_id",
"integration_key"
],
"type": "object"
},
"ReviewProperties": {
"properties": {
"author": {
"nullable": true,
"type": "string"
},
"classname": {
"nullable": true,
"type": "string"
},
"content": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"rating": {
"default": 5,
"example": 5,
"type": "integer"
},
"review_id": {
"nullable": true,
"type": "integer"
},
"show_author": {
"default": true,
"example": true,
"type": "boolean"
},
"show_rating": {
"default": true,
"example": true,
"type": "boolean"
},
"show_verified": {
"default": true,
"example": true,
"type": "boolean"
},
"verified": {
"default": false,
"type": "boolean"
}
},
"type": "object"
},
"ReviewPublicReply": {
"properties": {
"author": {
"description": "The author of the public reply",
"example": "Company X",
"type": "string"
},
"content": {
"description": "The content of the public reply",
"example": "Thanks for the review!",
"type": "string"
},
"updated": {
"description": "The datetime when this public reply was updated",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"content",
"author",
"updated"
],
"type": "object"
},
"ReviewResponseDTOObjectResource": {
"properties": {
"attributes": {
"properties": {
"author": {
"description": "The author of this review",
"example": "John D",
"nullable": true,
"type": "string"
},
"content": {
"description": "The content of this review",
"example": "Great product! I love the smell. I will be buying again.",
"nullable": true,
"type": "string"
},
"created": {
"description": "The datetime when this review was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"email": {
"description": "The email of the author of this review",
"example": "john@doe.com",
"nullable": true,
"type": "string"
},
"images": {
"description": "The list of images submitted with this review (represented as a list of urls). If there are no images, this field will be an empty list.",
"example": [
"https://example.com/image1.jpg",
"https://example.com/image2.jpg"
],
"items": {
"type": "string"
},
"type": "array"
},
"product": {
"$ref": "#/components/schemas/ReviewProductDTO",
"description": "The product associated with this review",
"nullable": true
},
"public_reply": {
"$ref": "#/components/schemas/ReviewPublicReply",
"description": "The public reply to this review (if one exists)",
"nullable": true
},
"rating": {
"description": "The rating of this review on a scale from 1-5. If the review type is \"question\", this field will be null.",
"example": 2,
"nullable": true,
"type": "integer"
},
"review_type": {
"description": "The type of this review \u2014 either a review, question, or rating",
"enum": [
"question",
"rating",
"review",
"store"
],
"example": "review",
"type": "string"
},
"smart_quote": {
"description": "A quote from this review that summarizes the content",
"example": "I love the smell",
"nullable": true,
"type": "string"
},
"status": {
"description": "The status of this review",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ReviewStatusRejected"
},
{
"$ref": "#/components/schemas/ReviewStatusFeatured"
},
{
"$ref": "#/components/schemas/ReviewStatusPublished"
},
{
"$ref": "#/components/schemas/ReviewStatusUnpublished"
},
{
"$ref": "#/components/schemas/ReviewStatusPending"
}
]
},
"title": {
"description": "The title of this review",
"example": "Smells great, would recommend",
"nullable": true,
"type": "string"
},
"updated": {
"description": "The datetime when this review was updated",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"verified": {
"description": "The verification status of this review (aka whether or not we have confirmation that the customer bought the product)",
"example": true,
"type": "boolean"
}
},
"required": [
"verified",
"review_type",
"created",
"updated",
"images"
],
"type": "object"
},
"id": {
"description": "The ID of the review",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"events": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "Related Events",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/EventEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"item": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Related Catalog Item",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogItemEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ReviewEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"ReviewStatusFeatured": {
"properties": {
"value": {
"description": "Featured review status",
"enum": [
"featured"
],
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"ReviewStatusPending": {
"properties": {
"value": {
"description": "Pending review status",
"enum": [
"pending"
],
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"ReviewStatusPublished": {
"properties": {
"value": {
"description": "Published review status",
"enum": [
"published"
],
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"ReviewStatusRejected": {
"properties": {
"rejection_reason": {
"description": "The updated status intended for the review with this ID",
"oneOf": [
{
"$ref": "#/components/schemas/RejectReasonOther"
},
{
"$ref": "#/components/schemas/RejectReasonFake"
},
{
"$ref": "#/components/schemas/RejectReasonMisleading"
},
{
"$ref": "#/components/schemas/RejectReasonPrivateInformation"
},
{
"$ref": "#/components/schemas/RejectReasonProfanity"
},
{
"$ref": "#/components/schemas/RejectReasonUnrelated"
}
]
},
"value": {
"description": "Rejected review status",
"enum": [
"rejected"
],
"type": "string"
}
},
"required": [
"value",
"rejection_reason"
],
"type": "object"
},
"ReviewStatusUnpublished": {
"properties": {
"value": {
"description": "Unpublished review status",
"enum": [
"unpublished"
],
"type": "string"
}
},
"required": [
"value"
],
"type": "object"
},
"ReviewStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"block_background_color": {
"default": "rgba(255, 255, 255, 0)",
"example": "rgba(255, 255, 255, 0)",
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
},
"quote_style": {
"$ref": "#/components/schemas/QuoteStyle"
},
"rating_style": {
"$ref": "#/components/schemas/RatingStyle"
},
"reviewer_name_style": {
"$ref": "#/components/schemas/ReviewerNameStyle"
}
},
"type": "object"
},
"ReviewValueReportGrouping": {
"properties": {
"groupings": {
"description": "Grouping details, either by product or company",
"oneOf": [
{
"$ref": "#/components/schemas/GroupingProduct"
},
{
"$ref": "#/components/schemas/GroupingCompany"
}
]
},
"statistics": {
"$ref": "#/components/schemas/StatisticsDTO",
"description": "Statistics related to the grouping",
"example": {
"average_rating": 4.5,
"average_store_rating": 2,
"total_questions": 50,
"total_ratings": 200,
"total_reviews": 100,
"total_store_reviews": 5000
}
}
},
"required": [
"groupings",
"statistics"
],
"type": "object"
},
"ReviewValuesReportEnum": {
"enum": [
"review-values-report"
],
"type": "string"
},
"ReviewValuesReportResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"results": {
"description": "The list of groupings and their corresponding statistics in the reviews values report",
"example": [
{
"groupings": {
"product_id": "id1"
},
"statistics": {
"average_rating": 4.5,
"total_ratings": 459
}
},
{
"groupings": {
"product_id": "id2"
},
"statistics": {
"average_rating": 2.5,
"total_ratings": 459
}
}
],
"items": {
"$ref": "#/components/schemas/ReviewValueReportGrouping"
},
"type": "array"
}
},
"required": [
"results"
],
"type": "object"
},
"id": {
"description": "The unique identifier for the reviews values report",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/ReviewValuesReportEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"ReviewerNameStyle": {
"properties": {
"alignment": {
"default": "center",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "center",
"type": "string"
},
"character_spacing": {
"default": 0,
"type": "integer"
},
"font_family": {
"default": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"example": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"type": "string"
},
"font_size": {
"default": 16,
"example": 16,
"type": "integer"
},
"font_weight": {
"default": 400,
"example": 400,
"type": "integer"
},
"layout": {
"default": "stacked",
"description": "Enumeration for review name layouts.",
"enum": [
"inline",
"stacked"
],
"example": "stacked",
"type": "string"
},
"line_height": {
"default": 1.5,
"example": 1.5,
"type": "number"
},
"text_color": {
"default": "#000000",
"example": "#000000",
"type": "string"
}
},
"type": "object"
},
"RichTextMargin": {
"properties": {
"bottom": {
"default": 0,
"type": "integer"
},
"left": {
"default": 0,
"enum": [
0
],
"type": "integer"
},
"right": {
"default": 0,
"enum": [
0
],
"type": "integer"
},
"top": {
"default": 0,
"enum": [
0
],
"type": "integer"
}
},
"type": "object"
},
"RichTextStyle": {
"properties": {
"alignment": {
"default": "left",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "left",
"type": "string"
},
"character_spacing": {
"default": 0,
"nullable": true,
"type": "integer"
},
"font_family": {
"default": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"example": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"oneOf": [
{
"description": "Web safe font enumeration.",
"enum": [
"Arial Black,Arial",
"Arial, 'Helvetica Neue', Helvetica, sans-serif",
"Century Gothic,AppleGothic,Arial",
"Comic Sans MS,Comic Sans,cursive",
"Courier",
"Courier New",
"Geneva,Arial",
"Georgia",
"Helvetica,Arial",
"Lucida Grande,Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"Lucida,Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"MS Serif,Georgia",
"New York,Georgia",
"Palatino Linotype,Palatino,Georgia",
"Palatino,Georgia",
"Tahoma,sans-serif",
"Times New Roman",
"Trebuchet MS",
"Verdana"
],
"type": "string"
},
{
"type": "string"
}
]
},
"font_size": {
"default": 16,
"example": 16,
"type": "integer"
},
"font_style": {
"nullable": true,
"type": "string"
},
"font_weight": {
"default": 400,
"description": "Font weight enumeration.",
"enum": [
100,
200,
300,
400,
500,
600,
700,
800,
900
],
"example": 400,
"nullable": true,
"type": "integer"
},
"line_spacing": {
"default": 1,
"example": 1,
"type": "number"
},
"margin": {
"$ref": "#/components/schemas/RichTextMargin"
},
"text_color": {
"default": "#000000",
"example": "#000000",
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RichTextStyles": {
"properties": {
"body": {
"$ref": "#/components/schemas/RichTextStyle"
},
"h1": {
"$ref": "#/components/schemas/RichTextStyle"
},
"h2": {
"$ref": "#/components/schemas/RichTextStyle"
},
"h3": {
"$ref": "#/components/schemas/RichTextStyle"
},
"h4": {
"$ref": "#/components/schemas/RichTextStyle"
},
"h5": {
"$ref": "#/components/schemas/RichTextStyle"
},
"h6": {
"$ref": "#/components/schemas/RichTextStyle"
},
"link": {
"$ref": "#/components/schemas/LinkStyles"
}
},
"type": "object"
},
"RowData": {
"properties": {
"styles": {
"$ref": "#/components/schemas/RowStyles"
}
},
"required": [
"styles"
],
"type": "object"
},
"RowStyles": {
"properties": {
"column_layout": {
"description": "Column layout.",
"enum": [
"1-column-full-width",
"2-columns-25%-75%",
"2-columns-33%-67%",
"2-columns-67%-33%",
"2-columns-75%-25%",
"2-columns-equal-width",
"3-columns-25%-25%-50%",
"3-columns-25%-50%-25%",
"3-columns-50%-25%-25%",
"3-columns-equal-width",
"4-columns-equal-width"
],
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"RowV0": {
"properties": {
"blocks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/Button"
},
{
"$ref": "#/components/schemas/AgeGate"
},
{
"$ref": "#/components/schemas/Coupon"
},
{
"$ref": "#/components/schemas/Date"
},
{
"$ref": "#/components/schemas/Email"
},
{
"$ref": "#/components/schemas/HTMLText"
},
{
"$ref": "#/components/schemas/OptInCode"
},
{
"$ref": "#/components/schemas/PhoneNumber"
},
{
"$ref": "#/components/schemas/SMSConsentCheckbox"
},
{
"$ref": "#/components/schemas/Text"
},
{
"$ref": "#/components/schemas/Checkboxes"
},
{
"$ref": "#/components/schemas/RadioButtons"
},
{
"$ref": "#/components/schemas/Dropdown"
},
{
"$ref": "#/components/schemas/Image"
},
{
"$ref": "#/components/schemas/CountdownTimer"
},
{
"$ref": "#/components/schemas/SignupCounter"
},
{
"$ref": "#/components/schemas/SpinToWin"
},
{
"$ref": "#/components/schemas/SMSDisclosure"
},
{
"$ref": "#/components/schemas/BackInStockEmailConsentCheckbox"
},
{
"$ref": "#/components/schemas/Review"
}
]
},
"type": "array"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
}
},
"required": [
"blocks"
],
"type": "object"
},
"RowV1": {
"properties": {
"columns": {
"items": {
"$ref": "#/components/schemas/ColumnV1"
},
"nullable": true,
"type": "array"
},
"data": {
"$ref": "#/components/schemas/RowData"
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"data"
],
"type": "object"
},
"SMSChannel": {
"properties": {
"marketing": {
"$ref": "#/components/schemas/SMSMarketing",
"description": "The SMS marketing subscription.",
"nullable": true
},
"transactional": {
"$ref": "#/components/schemas/SMSTransactional",
"description": "The SMS transactional subscription.",
"nullable": true
}
},
"type": "object"
},
"SMSConsentCheckbox": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/SMSConsentCheckboxProperties"
},
"styles": {
"$ref": "#/components/schemas/SMSConsentCheckboxStyles"
},
"type": {
"enum": [
"promotional_sms_checkbox"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"SMSConsentCheckboxProperties": {
"properties": {
"channels": {
"items": {
"description": "Consent channel enumeration.",
"enum": [
"sms",
"whatsapp"
],
"type": "string"
},
"type": "array"
},
"checkbox_text": {
"type": "string"
},
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"placeholder": {
"enum": [
null
]
},
"property_name": {
"default": "opt_in_promotional_sms",
"enum": [
"opt_in_promotional_sms"
],
"example": "opt_in_promotional_sms",
"type": "string"
},
"required": {
"default": false,
"enum": [
false
],
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
}
},
"required": [
"checkbox_text"
],
"type": "object"
},
"SMSConsentCheckboxStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"horizontal_alignment": {
"default": "left",
"description": "Horizontal alignment enumeration.",
"enum": [
"center",
"left",
"right"
],
"example": "left",
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"SMSContent": {
"properties": {
"body": {
"description": "The message body",
"example": "My preview sms",
"nullable": true,
"type": "string"
},
"media_url": {
"description": "URL for included media",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SMSContentCreate": {
"properties": {
"body": {
"description": "The message body",
"example": "My preview sms",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SMSContentSubObject": {
"properties": {
"body": {
"description": "The message body",
"example": "My preview sms",
"nullable": true,
"type": "string"
},
"media_url": {
"description": "URL for included media",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SMSDisclosure": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/SMSDisclosureProperties"
},
"styles": {
"$ref": "#/components/schemas/SMSDisclosureStyles"
},
"type": {
"enum": [
"sms_disclosure"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SMSDisclosureAccountDefault": {
"properties": {
"html": {
"nullable": true
},
"type": {
"enum": [
"account_default"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SMSDisclosureCustom": {
"properties": {
"compliance_company_name": {
"default": "[company name]",
"example": "[company name]",
"type": "string"
},
"html": {
"default": "",
"type": "string"
},
"privacy_policy_url": {
"default": "[link]",
"example": "[link]",
"type": "string"
},
"terms_of_service_url": {
"default": "[link]",
"example": "[link]",
"type": "string"
},
"type": {
"enum": [
"custom"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SMSDisclosureLinkTextStyle": {
"properties": {
"character_spacing": {
"default": 0,
"nullable": true,
"type": "integer"
},
"font_family": {
"default": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"example": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"oneOf": [
{
"description": "Web safe font enumeration.",
"enum": [
"Arial Black,Arial",
"Arial, 'Helvetica Neue', Helvetica, sans-serif",
"Century Gothic,AppleGothic,Arial",
"Comic Sans MS,Comic Sans,cursive",
"Courier",
"Courier New",
"Geneva,Arial",
"Georgia",
"Helvetica,Arial",
"Lucida Grande,Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"Lucida,Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"MS Serif,Georgia",
"New York,Georgia",
"Palatino Linotype,Palatino,Georgia",
"Palatino,Georgia",
"Tahoma,sans-serif",
"Times New Roman",
"Trebuchet MS",
"Verdana"
],
"type": "string"
},
{
"type": "string"
}
]
},
"font_size": {
"default": 16,
"example": 16,
"type": "integer"
},
"font_style": {
"nullable": true,
"type": "string"
},
"font_weight": {
"default": 400,
"description": "Font weight enumeration.",
"enum": [
100,
200,
300,
400,
500,
600,
700,
800,
900
],
"example": 400,
"nullable": true,
"type": "integer"
},
"text_color": {
"default": "#0066cc",
"example": "#0066cc",
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SMSDisclosureProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"content": {
"oneOf": [
{
"$ref": "#/components/schemas/SMSDisclosureCustom"
},
{
"$ref": "#/components/schemas/SMSDisclosureAccountDefault"
}
]
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SMSDisclosureStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"link_styles": {
"$ref": "#/components/schemas/SMSDisclosureLinkTextStyle"
},
"padding": {
"$ref": "#/components/schemas/Padding"
},
"text_styles": {
"$ref": "#/components/schemas/SMSDisclosureTextStyle"
}
},
"type": "object"
},
"SMSDisclosureTextStyle": {
"properties": {
"character_spacing": {
"default": 0,
"nullable": true,
"type": "integer"
},
"font_family": {
"default": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"example": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"oneOf": [
{
"description": "Web safe font enumeration.",
"enum": [
"Arial Black,Arial",
"Arial, 'Helvetica Neue', Helvetica, sans-serif",
"Century Gothic,AppleGothic,Arial",
"Comic Sans MS,Comic Sans,cursive",
"Courier",
"Courier New",
"Geneva,Arial",
"Georgia",
"Helvetica,Arial",
"Lucida Grande,Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"Lucida,Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"MS Serif,Georgia",
"New York,Georgia",
"Palatino Linotype,Palatino,Georgia",
"Palatino,Georgia",
"Tahoma,sans-serif",
"Times New Roman",
"Trebuchet MS",
"Verdana"
],
"type": "string"
},
{
"type": "string"
}
]
},
"font_size": {
"default": 16,
"example": 16,
"type": "integer"
},
"font_style": {
"nullable": true,
"type": "string"
},
"font_weight": {
"default": 400,
"description": "Font weight enumeration.",
"enum": [
100,
200,
300,
400,
500,
600,
700,
800,
900
],
"example": 400,
"nullable": true,
"type": "integer"
},
"text_color": {
"default": "#000000",
"example": "#000000",
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SMSMarketing": {
"properties": {
"can_receive_sms_marketing": {
"description": "Whether or not this profile is subscribed to receive SMS marketing.",
"type": "boolean"
},
"consent": {
"description": "The consent status for SMS marketing.",
"example": "SUBSCRIBED",
"type": "string"
},
"consent_timestamp": {
"description": "The timestamp when consent was recorded or updated for SMS marketing, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_updated": {
"description": "The timestamp when the SMS consent record was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"method": {
"description": "The method by which the profile was subscribed to SMS marketing.",
"example": "TEXT",
"nullable": true,
"type": "string"
},
"method_detail": {
"default": "",
"description": "Additional details about the method which the profile was subscribed to SMS marketing. This may be empty if no details were provided.",
"example": "JOIN",
"nullable": true,
"type": "string"
}
},
"required": [
"can_receive_sms_marketing",
"consent"
],
"type": "object"
},
"SMSMessageDefinition": {
"properties": {
"channel": {
"enum": [
"sms"
],
"type": "string"
},
"content": {
"$ref": "#/components/schemas/SMSContent",
"description": "Additional attributes relating to the content of the message",
"nullable": true
},
"render_options": {
"$ref": "#/components/schemas/RenderOptions",
"description": "Additional options for rendering the message",
"nullable": true
}
},
"required": [
"channel"
],
"type": "object"
},
"SMSMessageDefinitionCreate": {
"properties": {
"channel": {
"enum": [
"sms"
],
"type": "string"
},
"content": {
"$ref": "#/components/schemas/SMSContentCreate",
"description": "Additional attributes relating to the content of the message",
"nullable": true
},
"render_options": {
"$ref": "#/components/schemas/RenderOptions",
"description": "Additional options for rendering the message",
"nullable": true
}
},
"required": [
"channel"
],
"type": "object"
},
"SMSSendOptions": {
"properties": {
"use_smart_sending": {
"default": true,
"description": "Use smart sending.",
"example": true,
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"SMSSubscriptionParameters": {
"properties": {
"marketing": {
"$ref": "#/components/schemas/SubscriptionParameters",
"description": "The parameters to subscribe to marketing on the \"SMS\" Channel.",
"nullable": true
},
"transactional": {
"$ref": "#/components/schemas/SubscriptionParameters",
"description": "The parameters to subscribe to transactional messaging on the \"SMS\" Channel.",
"nullable": true
}
},
"type": "object"
},
"SMSTransactional": {
"properties": {
"can_receive_sms_transactional": {
"description": "Whether or not this profile is subscribed to receive transactional SMS.",
"type": "boolean"
},
"consent": {
"description": "The consent status for SMS Transactional.",
"example": "SUBSCRIBED",
"type": "string"
},
"consent_timestamp": {
"description": "The timestamp when consent was recorded or updated for Transactional SMS messaging , in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_updated": {
"description": "The timestamp when the SMS consent record was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"method": {
"description": "The method by which the profile was subscribed to Transactional SMS messaging .",
"example": "TEXT",
"nullable": true,
"type": "string"
},
"method_detail": {
"default": "",
"description": "Additional details about the method which the profile was subscribed to Transactional SMS messaging. This may be empty if no details were provided.",
"example": "JOIN",
"nullable": true,
"type": "string"
}
},
"required": [
"can_receive_sms_transactional",
"consent"
],
"type": "object"
},
"SMSUnsubscriptionParameters": {
"properties": {
"marketing": {
"$ref": "#/components/schemas/UnsubscriptionParameters",
"description": "The parameters to unsubscribe from marketing on the \"SMS\" channel.",
"nullable": true
},
"transactional": {
"$ref": "#/components/schemas/UnsubscriptionParameters",
"description": "The parameters to unsubscribe from transactional messaging on the \"SMS\" channel.",
"nullable": true
}
},
"type": "object"
},
"Scroll": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/ScrollProperties"
},
"type": {
"enum": [
"scroll_percentage"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"ScrollProperties": {
"properties": {
"percentage": {
"default": 30,
"example": 30,
"type": "integer"
}
},
"type": "object"
},
"SectionData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"properties": {
"$ref": "#/components/schemas/SectionProperties"
},
"styles": {
"$ref": "#/components/schemas/SectionStyles"
}
},
"required": [
"properties",
"display_options",
"styles"
],
"type": "object"
},
"SectionProperties": {
"properties": {
"is_ai_generated": {
"nullable": true,
"type": "boolean"
},
"is_prebuilt_content": {
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"SectionStyles": {
"properties": {
"background_asset_id": {
"nullable": true,
"type": "string"
},
"background_color": {
"nullable": true,
"type": "string"
},
"background_format": {
"description": "Background format.",
"enum": [
"auto",
"contain",
"cover",
"initial",
"repeat"
],
"nullable": true,
"type": "string"
},
"background_image_full_width": {
"nullable": true,
"type": "boolean"
},
"background_position": {
"description": "Background position.",
"enum": [
"center-bottom",
"center-center",
"center-top",
"left-bottom",
"left-center",
"left-top",
"right-bottom",
"right-center",
"right-top"
],
"nullable": true,
"type": "string"
},
"background_repeat": {
"nullable": true,
"type": "boolean"
},
"background_url": {
"nullable": true,
"type": "string"
},
"border_color": {
"nullable": true,
"type": "string"
},
"border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"border_width": {
"nullable": true,
"type": "integer"
},
"column_align": {
"description": "Vertical alignment.",
"enum": [
"baseline",
"bottom",
"middle",
"top"
],
"nullable": true,
"type": "string"
},
"column_direction": {
"description": "Stacking direction.",
"enum": [
"ltr",
"no-stack",
"rtl"
],
"nullable": true,
"type": "string"
},
"content_color": {
"nullable": true,
"type": "string"
},
"content_color_type": {
"description": "Content color type.",
"enum": [
"none",
"section",
"template"
],
"nullable": true,
"type": "string"
},
"inner_padding_bottom": {
"nullable": true,
"type": "integer"
},
"inner_padding_left": {
"nullable": true,
"type": "integer"
},
"inner_padding_right": {
"nullable": true,
"type": "integer"
},
"inner_padding_top": {
"nullable": true,
"type": "integer"
},
"stack_on_mobile": {
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"SectionV0": {
"properties": {
"content_type": {
"enum": [
"section"
],
"type": "string"
},
"data": {
"nullable": true
},
"type": {
"enum": [
"section"
],
"type": "string"
}
},
"required": [
"content_type",
"type"
],
"type": "object"
},
"SectionV1": {
"properties": {
"content_type": {
"enum": [
"section"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/SectionData"
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"rows": {
"items": {
"$ref": "#/components/schemas/RowV1"
},
"nullable": true,
"type": "array"
},
"type": {
"enum": [
"section"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"SegmentCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/SegmentCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"SegmentCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"definition": {
"$ref": "#/components/schemas/SegmentDefinition"
},
"is_starred": {
"default": false,
"nullable": true,
"type": "boolean"
},
"name": {
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"SegmentDefinition": {
"properties": {
"condition_groups": {
"items": {
"$ref": "#/components/schemas/ConditionGroup"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"SegmentEnum": {
"enum": [
"segment"
],
"type": "string"
},
"SegmentListResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/SegmentDefinition",
"nullable": true
},
"is_active": {
"description": "Whether the segment is active. Inactive segments are not processed and their membership does not update.",
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"is_starred": {
"type": "boolean"
},
"name": {
"description": "A helpful name to label the segment",
"example": "Repeat Purchasers",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"is_active",
"is_processing",
"is_starred"
],
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"SegmentMemberResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the profile was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"email": {
"description": "Individual's email address",
"example": "sarah.mason@klaviyo-demo.com",
"nullable": true,
"type": "string"
},
"external_id": {
"description": "A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.",
"nullable": true,
"type": "string"
},
"first_name": {
"description": "Individual's first name",
"example": "Sarah",
"nullable": true,
"type": "string"
},
"image": {
"description": "URL pointing to the location of a profile image",
"example": "https://images.pexels.com/photos/3760854/pexels-photo-3760854.jpeg",
"nullable": true,
"type": "string"
},
"joined_group_at": {
"description": "The datetime when this profile most recently joined the segment.",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"last_event_date": {
"description": "Date and time of the most recent event the triggered an update to the profile, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_name": {
"description": "Individual's last name",
"example": "Mason",
"nullable": true,
"type": "string"
},
"locale": {
"description": "The locale of the profile, in the IETF BCP 47 language tag format like (ISO 639-1/2)-(ISO 3166 alpha-2)",
"example": "en-US",
"nullable": true,
"type": "string"
},
"location": {
"$ref": "#/components/schemas/ProfileLocation",
"nullable": true
},
"organization": {
"description": "Name of the company or organization within the company for whom the individual works",
"example": "Example Corporation",
"nullable": true,
"type": "string"
},
"phone_number": {
"description": "Individual's phone number in E.164 format",
"example": "+15005550006",
"nullable": true,
"type": "string"
},
"properties": {
"description": "An object containing key/value pairs for any custom properties assigned to this profile",
"example": {
"pseudonym": "Dr. Octopus"
},
"nullable": true,
"type": "object"
},
"title": {
"description": "Individual's job title",
"example": "Regional Manager",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the profile was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"joined_group_at"
],
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"push-tokens": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/PushTokenEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"attributes",
"links"
],
"type": "object"
},
"SegmentPartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/SegmentPartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"SegmentPartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"definition": {
"$ref": "#/components/schemas/SegmentDefinition",
"nullable": true
},
"is_active": {
"description": "Set to false to deactivate the segment. When deactivating, this must be the only attribute in the request body. Deactivation cannot be combined with other updates. Marking a segment inactive will impact campaigns, flows, ad syncs, forms, helpdesk routing, and other features that reference this segment. Set to true to reactivate a deactivated segment.",
"nullable": true,
"type": "boolean"
},
"is_starred": {
"nullable": true,
"type": "boolean"
},
"name": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"SegmentResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/SegmentDefinition",
"nullable": true
},
"is_active": {
"description": "Whether the segment is active. Inactive segments are not processed and their membership does not update.",
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"is_starred": {
"type": "boolean"
},
"name": {
"description": "A helpful name to label the segment",
"example": "Repeat Purchasers",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"is_active",
"is_processing",
"is_starred"
],
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"SegmentRetrieveResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "Date and time when the segment was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/SegmentDefinition",
"nullable": true
},
"is_active": {
"description": "Whether the segment is active. Inactive segments are not processed and their membership does not update.",
"type": "boolean"
},
"is_processing": {
"type": "boolean"
},
"is_starred": {
"type": "boolean"
},
"name": {
"description": "A helpful name to label the segment",
"example": "Repeat Purchasers",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the segment was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"is_active",
"is_processing",
"is_starred"
],
"type": "object"
},
"id": {
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"flow-triggers": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"profiles": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ProfileEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"SegmentSeriesReportEnum": {
"enum": [
"segment-series-report"
],
"type": "string"
},
"SegmentSeriesRequestDTO": {
"properties": {
"data": {
"$ref": "#/components/schemas/SegmentSeriesRequestDTOResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"SegmentSeriesRequestDTOResourceObject": {
"properties": {
"attributes": {
"properties": {
"filter": {
"description": "API filter string used to filter the query.\nAllowed filters are segment_id.\nAllowed operators are equals, any.\nOnly one filter can be used per attribute.\nMax of 100 messages per ANY filter.",
"example": "any(segment_id,[\"xyz123\",\"ghi456\"])",
"nullable": true,
"type": "string"
},
"interval": {
"description": "The interval used to aggregate data within the series request.\nIf hourly is used, the timeframe cannot be longer than 7 days.\nIf daily is used, the timeframe cannot be longer than 60 days.\nIf monthly is used, the timeframe cannot be longer than 52 weeks.",
"enum": [
"daily",
"hourly",
"monthly",
"weekly"
],
"example": "weekly",
"type": "string"
},
"statistics": {
"description": "List of statistics to query for.",
"example": [
"total_members",
"net_members_changed"
],
"items": {
"description": "Defined segment reporting metric",
"enum": [
"members_added",
"members_removed",
"net_members_changed",
"total_members"
],
"type": "string"
},
"type": "array"
},
"timeframe": {
"description": "The time frame to pull data from (Max length: 1 year). Data is unavailable before June 1st, 2023. Please use a time frame after this date. See [available time frames](https://developers.klaviyo.com/en/reference/reporting_api_overview#available-time-frames).",
"oneOf": [
{
"$ref": "#/components/schemas/Timeframe"
},
{
"$ref": "#/components/schemas/CustomTimeframe"
}
]
}
},
"required": [
"statistics",
"timeframe",
"interval"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SegmentSeriesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"SegmentTrigger": {
"properties": {
"id": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"segment"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SegmentValuesReportEnum": {
"enum": [
"segment-values-report"
],
"type": "string"
},
"SegmentValuesRequestDTO": {
"properties": {
"data": {
"$ref": "#/components/schemas/SegmentValuesRequestDTOResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"SegmentValuesRequestDTOResourceObject": {
"properties": {
"attributes": {
"properties": {
"filter": {
"description": "API filter string used to filter the query.\nAllowed filters are segment_id.\nAllowed operators are equals, any.\nOnly one filter can be used per attribute.\nMax of 100 messages per ANY filter.",
"example": "any(segment_id,[\"xyz123\",\"ghi456\"])",
"nullable": true,
"type": "string"
},
"statistics": {
"description": "List of statistics to query for.",
"example": [
"total_members",
"net_members_changed"
],
"items": {
"description": "Defined segment reporting metric",
"enum": [
"members_added",
"members_removed",
"net_members_changed",
"total_members"
],
"type": "string"
},
"type": "array"
},
"timeframe": {
"description": "The time frame to pull data from (Max length: 1 year). Data is unavailable before June 1st, 2023. Please use a time frame after this date. See [available time frames](https://developers.klaviyo.com/en/reference/reporting_api_overview#available-time-frames).",
"oneOf": [
{
"$ref": "#/components/schemas/Timeframe"
},
{
"$ref": "#/components/schemas/CustomTimeframe"
}
]
}
},
"required": [
"statistics",
"timeframe"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/SegmentValuesReportEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"SegmentsProfileMetricCondition": {
"properties": {
"measurement": {
"description": "Measurements for profile metrics.",
"enum": [
"count",
"sum"
],
"type": "string"
},
"measurement_filter": {
"$ref": "#/components/schemas/NumericOperatorNumericFilter"
},
"metric_filters": {
"items": {
"$ref": "#/components/schemas/ProfileMetricPropertyFilter"
},
"nullable": true,
"type": "array"
},
"metric_id": {
"type": "string"
},
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/AlltimeDateFilter"
}
]
},
"type": {
"enum": [
"profile-metric"
],
"type": "string"
}
},
"required": [
"type",
"metric_id",
"measurement",
"measurement_filter",
"timeframe_filter"
],
"type": "object"
},
"SegmentsProfileMetricFunnelCondition": {
"properties": {
"completion_window_seconds": {
"description": "Allowed completion window durations for funnel conditions (in\n seconds).",
"enum": [
"DAYS_1",
"DAYS_180",
"DAYS_3",
"DAYS_30",
"DAYS_5",
"DAYS_90",
"HOURS_1",
"WEEKS_1",
"YEARS_1"
],
"nullable": true,
"type": "string"
},
"steps": {
"items": {
"$ref": "#/components/schemas/ProfileMetricFunnelSteps"
},
"type": "array"
},
"timeframe_filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
}
]
},
"type": {
"enum": [
"profile-metric-funnel"
],
"type": "string"
}
},
"required": [
"type",
"timeframe_filter",
"steps"
],
"type": "object"
},
"SendEmailAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/SendEmailActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"send-email"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SendEmailActionData": {
"properties": {
"message": {
"$ref": "#/components/schemas/FlowEmail",
"nullable": true
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"type": "object"
},
"SendInternalAlertAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/SendInternalAlertActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"send-internal-alert"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SendInternalAlertActionData": {
"properties": {
"message": {
"$ref": "#/components/schemas/FlowInternalAlert"
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"SendPushNotificationAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/SendPushNotificationActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"send-mobile-push"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SendPushNotificationActionData": {
"properties": {
"message": {
"$ref": "#/components/schemas/FlowPushNotification",
"nullable": true
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"type": "object"
},
"SendSmsAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/SendSmsActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"send-sms"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SendSmsActionData": {
"properties": {
"message": {
"$ref": "#/components/schemas/FlowSms",
"nullable": true
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"type": "object"
},
"SendTime": {
"properties": {
"datetime": {
"description": "The datetime that the message is to be sent",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"is_local": {
"description": "Whether that datetime is to be a local datetime for the recipient",
"type": "boolean"
}
},
"required": [
"datetime",
"is_local"
],
"type": "object"
},
"SendTimeSubObject": {
"properties": {
"datetime": {
"description": "The datetime that the message is to be sent",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"is_local": {
"description": "Whether that datetime is to be a local datetime for the recipient",
"type": "boolean"
}
},
"required": [
"datetime",
"is_local"
],
"type": "object"
},
"SendWebhookAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/SendWebhookActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"send-webhook"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SendWebhookActionData": {
"properties": {
"message": {
"$ref": "#/components/schemas/FlowWebhook"
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"SendWhatsAppAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/SendWhatsAppActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"send-whatsapp"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SendWhatsAppActionData": {
"properties": {
"message": {
"$ref": "#/components/schemas/FlowWhatsApp",
"nullable": true
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"type": "object"
},
"SeriesData": {
"properties": {
"groupings": {
"description": "Applied groupings and the values for this object",
"type": "object"
},
"statistics": {
"description": "Requested statistics and their series result",
"type": "object"
}
},
"required": [
"groupings",
"statistics"
],
"type": "object"
},
"ServerBISSubscriptionCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/ServerBISSubscriptionCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"ServerBISSubscriptionCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"channels": {
"description": "The channel(s) through which the profile would like to receive the back in stock notification. This can be leveraged within a back in stock flow to notify the subscriber through their preferred channel(s).",
"example": [
"EMAIL",
"SMS"
],
"items": {
"description": "The different channel types that a profile could subscribe to BIS notifications for",
"enum": [
"EMAIL",
"PUSH",
"SMS",
"WHATSAPP"
],
"type": "string"
},
"type": "array"
},
"profile": {
"example": {
"data": {
"attributes": {
"email": "sarah.mason@klaviyo-demo.com",
"external_id": "63f64a2b-c6bf-40c7-b81f-bed08162edbe",
"id": "01GDDKASAP8TKDDA2GRZDSVP4H",
"phone_number": "+15005550006"
},
"type": "profile"
}
},
"nullable": true,
"properties": {
"data": {
"$ref": "#/components/schemas/ProfileIdentifierDTOResourceObject"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"channels"
],
"type": "object"
},
"relationships": {
"properties": {
"variant": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The catalog variant ID for which the profile is subscribing to back in stock notifications. This ID is made up of the integration type, catalog ID, and and the external ID of the variant like so: `integrationType:::catalogId:::externalId`. If the integration you are using is not set up for multi-catalog storage, the 'catalogId' will be `$default`. For Shopify `$shopify:::$default:::33001893429341`",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CatalogVariantEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"required": [
"variant"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/BackInStockSubscriptionEnum"
}
},
"required": [
"type",
"attributes",
"relationships"
],
"type": "object"
},
"SftpMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"sftp"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"ShopifyIntegrationFilter": {
"properties": {
"operator": {
"enum": [
"in"
],
"type": "string"
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"value": {
"items": {
"enum": [
"shopify"
],
"type": "string"
},
"type": "array"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"ShopifyIntegrationMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/ShopifyIntegrationFilter"
},
"method": {
"enum": [
"integration"
],
"type": "string"
}
},
"required": [
"field",
"method",
"filter"
],
"type": "object"
},
"SideImageSettings": {
"properties": {
"alignment": {
"default": "left",
"description": "Side image alignment enumeration.",
"enum": [
"left",
"right"
],
"example": "left",
"type": "string"
},
"device_type": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"size": {
"default": "medium",
"description": "Side image size enumeration.",
"enum": [
"large",
"medium",
"small"
],
"example": "medium",
"type": "string"
}
},
"type": "object"
},
"SignupCounter": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/SignupCounterProperties"
},
"styles": {
"$ref": "#/components/schemas/SignupCounterStyles"
},
"type": {
"enum": [
"signup_counter"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"SignupCounterProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"content": {
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"min_submits": {
"type": "integer"
},
"timeframe": {
"description": "Timeframes for the signup counter lookback.",
"enum": [
"1_hour",
"24_hours",
"30_days",
"7_days"
],
"type": "string"
}
},
"required": [
"timeframe",
"min_submits",
"content"
],
"type": "object"
},
"SignupCounterStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"SinceFlowStartDateFilter": {
"properties": {
"operator": {
"description": "Possible operators for since flow start date.",
"enum": [
"flow-start"
],
"type": "string"
},
"type": {
"enum": [
"date"
],
"type": "string"
}
},
"required": [
"type",
"operator"
],
"type": "object"
},
"SkipToSuccess": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/SkipToSuccessProperties"
},
"submit": {
"default": false,
"enum": [
false
],
"type": "boolean"
},
"type": {
"enum": [
"skip_to_success"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"SkipToSuccessProperties": {
"maxProperties": 0,
"type": "object"
},
"SmartSendTimeStrategy": {
"properties": {
"date": {
"description": "The day to send on",
"format": "date",
"type": "string"
},
"method": {
"enum": [
"smart_send_time"
],
"type": "string"
}
},
"required": [
"method",
"date"
],
"type": "object"
},
"SocialBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"properties": {
"$ref": "#/components/schemas/SocialBlockProperties"
},
"styles": {
"$ref": "#/components/schemas/SocialBlockStyles"
}
},
"required": [
"properties",
"display_options",
"styles"
],
"type": "object"
},
"SocialBlockProperties": {
"properties": {
"show_labels": {
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"SocialBlockStyles": {
"properties": {
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"icon_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"icon_color": {
"description": "Social block icon color.",
"enum": [
"black",
"default",
"grey",
"white"
],
"nullable": true,
"type": "string"
},
"icon_size": {
"description": "Social block icon size.",
"enum": [
"large",
"medium",
"small"
],
"nullable": true,
"type": "string"
},
"icon_spacing": {
"nullable": true,
"type": "integer"
},
"label_color": {
"nullable": true,
"type": "string"
},
"label_font_family": {
"nullable": true,
"type": "string"
},
"label_font_size": {
"nullable": true,
"type": "integer"
},
"label_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"label_font_weight": {
"nullable": true,
"type": "string"
},
"label_text_decoration": {
"nullable": true,
"type": "string"
},
"stack_on_mobile": {
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"SocialBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"type": {
"enum": [
"social"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"SocialBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/SocialBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"subblocks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/SocialIconSubBlock"
},
{
"$ref": "#/components/schemas/SocialSpacerSubBlock"
}
]
},
"nullable": true,
"type": "array"
},
"type": {
"enum": [
"social"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"SocialIconSubBlock": {
"properties": {
"custom_asset_id": {
"nullable": true,
"type": "string"
},
"custom_size": {
"nullable": true,
"type": "integer"
},
"custom_src": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"label": {
"nullable": true,
"type": "string"
},
"link_type": {
"description": "Social block link type.",
"enum": [
"android",
"apple",
"custom",
"discord",
"email",
"facebook",
"google-plus",
"instagram",
"linkedin",
"pinterest",
"rss",
"snapchat",
"threads",
"tiktok",
"twitch",
"twitter",
"whatsapp",
"x-twitter",
"yelp",
"youtube"
],
"nullable": true,
"type": "string"
},
"link_url": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"social_link_icon"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SocialSpacerSubBlock": {
"properties": {
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"social_link_spacer"
],
"type": "string"
},
"width": {
"nullable": true,
"type": "integer"
}
},
"required": [
"type"
],
"type": "object"
},
"SpacerBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"styles": {
"$ref": "#/components/schemas/SpacerBlockStyles"
}
},
"required": [
"display_options",
"styles"
],
"type": "object"
},
"SpacerBlockStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"height": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"SpacerBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true
},
"type": {
"enum": [
"spacer"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"SpacerBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/SpacerBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"spacer"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"SpamComplaintMethodFilter": {
"properties": {
"field": {
"enum": [
"method"
],
"type": "string"
},
"method": {
"enum": [
"spam_complaint"
],
"type": "string"
}
},
"required": [
"field",
"method"
],
"type": "object"
},
"SpinToWin": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/SpinToWinProperties"
},
"styles": {
"$ref": "#/components/schemas/SpinToWinStyles"
},
"type": {
"enum": [
"spin_to_win"
],
"type": "string"
}
},
"required": [
"properties",
"type"
],
"type": "object"
},
"SpinToWinProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"duplicate_slices": {
"default": false,
"type": "boolean"
},
"slices": {
"items": {
"$ref": "#/components/schemas/SpinToWinSliceConfig"
},
"type": "array"
}
},
"required": [
"slices"
],
"type": "object"
},
"SpinToWinSliceConfig": {
"properties": {
"label": {
"type": "string"
},
"probability": {
"type": "integer"
},
"step_id": {
"type": "string"
}
},
"required": [
"label",
"probability",
"step_id"
],
"type": "object"
},
"SpinToWinSliceStyle": {
"properties": {
"background_color": {
"default": "rgba(0,0,0,1)",
"example": "rgba(0,0,0,1)",
"type": "string"
},
"text_color": {
"default": "rgba(255,255,255,1)",
"example": "rgba(255,255,255,1)",
"type": "string"
}
},
"type": "object"
},
"SpinToWinStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"center_color": {
"default": "rgba(255,255,255,1)",
"example": "rgba(255,255,255,1)",
"type": "string"
},
"outline_color": {
"default": "rgba(0,0,0,1)",
"example": "rgba(0,0,0,1)",
"type": "string"
},
"outline_thickness": {
"default": 12,
"example": 12,
"type": "integer"
},
"padding": {
"$ref": "#/components/schemas/Padding"
},
"pin_color": {
"default": "rgba(255,255,255,1)",
"example": "rgba(255,255,255,1)",
"type": "string"
},
"slice_styles": {
"items": {
"$ref": "#/components/schemas/SpinToWinSliceStyle"
},
"type": "array"
},
"text_styles": {
"$ref": "#/components/schemas/TextStyleV0"
},
"wheel_size": {
"default": 400,
"example": 400,
"type": "integer"
}
},
"type": "object"
},
"SplitBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"styles": {
"$ref": "#/components/schemas/SplitBlockStyles"
}
},
"required": [
"display_options",
"styles"
],
"type": "object"
},
"SplitBlockStyles": {
"properties": {
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"column_widths": {
"nullable": true,
"type": "string"
},
"mobile_stack_order": {
"description": "Stacking direction.",
"enum": [
"ltr",
"no-stack",
"rtl"
],
"nullable": true,
"type": "string"
},
"padding_in_between": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"SplitBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"type": {
"enum": [
"split"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"SplitBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/SplitBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"subblocks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TableTextSubBlock"
},
{
"$ref": "#/components/schemas/TableImageSubBlock"
},
{
"$ref": "#/components/schemas/TableHtmlSubBlock"
}
]
},
"nullable": true,
"type": "array"
},
"type": {
"enum": [
"split"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"StaticCount": {
"properties": {
"badge_config": {
"enum": [
"set_count"
],
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"badge_config",
"value"
],
"type": "object"
},
"StaticCouponConfig": {
"properties": {
"text": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"static"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"StaticDateFilter": {
"properties": {
"date": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"operator": {
"description": "Operators for static date filters.\n\nE.g. \"before 2023-01-01\"",
"enum": [
"after",
"before"
],
"type": "string"
},
"type": {
"enum": [
"date"
],
"type": "string"
}
},
"required": [
"type",
"operator",
"date"
],
"type": "object"
},
"StaticDateRangeFilter": {
"properties": {
"end": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"operator": {
"description": "Operators for static date range filters.\n\nE.g. \"between 2023-01-01 and 2023-02-01\"",
"enum": [
"between-static"
],
"type": "string"
},
"start": {
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"type": {
"enum": [
"date"
],
"type": "string"
}
},
"required": [
"type",
"operator",
"start",
"end"
],
"type": "object"
},
"StaticImageBlockProperties": {
"properties": {
"alt_text": {
"nullable": true,
"type": "string"
},
"asset_id": {
"nullable": true,
"type": "string"
},
"cropping_properties": {
"$ref": "#/components/schemas/ImageBlockCroppingProperties",
"nullable": true,
"readOnly": true
},
"dynamic": {
"enum": [
false
],
"nullable": true,
"type": "boolean"
},
"href": {
"nullable": true,
"type": "string"
},
"src": {
"nullable": true,
"type": "string"
}
},
"required": [
"dynamic"
],
"type": "object"
},
"StaticProductBlockProperties": {
"properties": {
"dynamic": {
"enum": [
false
],
"nullable": true,
"type": "boolean"
},
"is_ai_generated": {
"nullable": true,
"type": "boolean"
},
"is_prebuilt_content": {
"nullable": true,
"type": "boolean"
},
"item_subtype_id": {
"nullable": true,
"type": "integer"
},
"language": {
"nullable": true,
"type": "string"
},
"localize_for_recipient": {
"nullable": true,
"type": "boolean"
},
"region": {
"nullable": true,
"type": "string"
},
"show_button": {
"nullable": true,
"type": "boolean"
},
"show_description": {
"nullable": true,
"type": "boolean"
},
"show_original_price": {
"nullable": true,
"type": "boolean"
},
"show_price": {
"nullable": true,
"type": "boolean"
},
"show_rating": {
"nullable": true,
"type": "boolean"
},
"show_rating_count": {
"nullable": true,
"type": "boolean"
},
"show_title": {
"nullable": true,
"type": "boolean"
},
"show_title_links": {
"nullable": true,
"type": "boolean"
},
"title_placeholder": {
"nullable": true,
"type": "string"
}
},
"required": [
"dynamic"
],
"type": "object"
},
"StaticReviewBlockProperties": {
"properties": {
"author": {
"nullable": true,
"type": "string"
},
"author_placeholder": {
"nullable": true,
"type": "string"
},
"dynamic": {
"enum": [
false
],
"nullable": true,
"type": "boolean"
},
"product_name": {
"nullable": true,
"type": "string"
},
"product_name_placeholder": {
"nullable": true,
"type": "string"
},
"product_variant_name": {
"nullable": true,
"type": "string"
},
"product_variant_name_placeholder": {
"nullable": true,
"type": "string"
},
"quote": {
"nullable": true,
"type": "string"
},
"quote_placeholder": {
"nullable": true,
"type": "string"
},
"show_product_name": {
"nullable": true,
"type": "boolean"
},
"show_rating": {
"nullable": true,
"type": "boolean"
},
"show_reviewer_name": {
"nullable": true,
"type": "boolean"
},
"show_variant_name": {
"nullable": true,
"type": "boolean"
},
"show_verified_badge": {
"nullable": true,
"type": "boolean"
},
"stars": {
"nullable": true,
"type": "integer"
},
"verified": {
"nullable": true,
"type": "boolean"
},
"verified_badge_language": {
"description": "Review block verified badge language.",
"enum": [
"dutch",
"english",
"french",
"german",
"hungarian",
"italian",
"japanese",
"korean",
"portuguese",
"spanish"
],
"nullable": true,
"type": "string"
}
},
"required": [
"dynamic"
],
"type": "object"
},
"StaticSendStrategy": {
"properties": {
"datetime": {
"description": "The time to send at",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"method": {
"enum": [
"static"
],
"type": "string"
},
"options": {
"description": "If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/LocalStaticSend"
},
{
"$ref": "#/components/schemas/NonLocalStaticSend"
}
]
}
},
"required": [
"method",
"datetime"
],
"type": "object"
},
"StaticTableBlockProperties": {
"properties": {
"dynamic": {
"enum": [
false
],
"nullable": true,
"type": "boolean"
},
"num_columns": {
"nullable": true,
"type": "integer"
},
"show_headers": {
"nullable": true,
"type": "boolean"
}
},
"required": [
"dynamic"
],
"type": "object"
},
"StaticTrackingParam": {
"properties": {
"name": {
"description": "Name of the tracking param",
"example": "utm_medium",
"type": "string"
},
"type": {
"description": "The type of the tracking parameter",
"enum": [
"static"
],
"type": "string"
},
"value": {
"description": "The value of the tracking parameter",
"type": "string"
}
},
"required": [
"type",
"value",
"name"
],
"type": "object"
},
"StatisticsDTO": {
"properties": {
"average_rating": {
"description": "The average rating",
"example": 4.5,
"nullable": true,
"type": "number"
},
"average_store_rating": {
"description": "The average rating of store reviews",
"example": 2,
"nullable": true,
"type": "number"
},
"total_questions": {
"description": "The total number of questions",
"example": 50,
"nullable": true,
"type": "integer"
},
"total_ratings": {
"description": "The total number of ratings",
"example": 200,
"nullable": true,
"type": "integer"
},
"total_reviews": {
"description": "The total number of reviews",
"example": 100,
"nullable": true,
"type": "integer"
},
"total_store_reviews": {
"description": "The total number of store reviews",
"example": 5000,
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"StatusDateFilter": {
"properties": {
"field": {
"enum": [
"status_date"
],
"type": "string"
},
"filter": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticDateFilter"
},
{
"$ref": "#/components/schemas/StaticDateRangeFilter"
},
{
"$ref": "#/components/schemas/RelativeDateOperatorBaseRelativeDateFilter"
},
{
"$ref": "#/components/schemas/RelativeAnniversaryDateFilter"
},
{
"$ref": "#/components/schemas/RelativeDateRangeFilter"
},
{
"$ref": "#/components/schemas/CalendarDateFilter"
},
{
"$ref": "#/components/schemas/AnniversaryDateFilter"
}
]
}
},
"required": [
"field",
"filter"
],
"type": "object"
},
"Step": {
"properties": {
"columns": {
"items": {
"$ref": "#/components/schemas/ColumnV0"
},
"type": "array"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"name": {
"nullable": true,
"type": "string"
},
"steps": {
"items": {
"$ref": "#/components/schemas/Step"
},
"nullable": true,
"type": "array"
}
},
"required": [
"columns"
],
"type": "object"
},
"StreetAddress": {
"properties": {
"address1": {
"example": "125 Summer Street",
"nullable": true,
"type": "string"
},
"address2": {
"example": "5th Floor",
"nullable": true,
"type": "string"
},
"city": {
"example": "Boston",
"type": "string"
},
"country": {
"description": "Two-letter [ISO country code](https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)",
"example": "US",
"nullable": true,
"type": "string"
},
"region": {
"description": "State, province, or region.",
"example": "MA",
"nullable": true,
"type": "string"
},
"zip": {
"example": "04323",
"nullable": true,
"type": "string"
}
},
"required": [
"city"
],
"type": "object"
},
"StringArrayOperatorStringArrayFilter": {
"properties": {
"operator": {
"description": "Operators for string-in-array filters.",
"enum": [
"in",
"not-in"
],
"type": "string"
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"value": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"StringInArrayFilter": {
"properties": {
"operator": {
"enum": [
"in"
],
"type": "string"
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"value": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"operator",
"value",
"type"
],
"type": "object"
},
"StringOperatorStringFilter": {
"properties": {
"operator": {
"description": "Operators for string filters.",
"enum": [
"contains",
"ends-with",
"equals",
"not-contains",
"not-ends-with",
"not-equals",
"not-starts-with",
"nregex",
"regex",
"starts-with"
],
"type": "string"
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"value": {
"nullable": true,
"type": "string"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"StringPhoneOperatorStringArrayFilter": {
"properties": {
"operator": {
"description": "Operators for phone string array filters.\n\nExample condition using this filter:\n {\n \"type\": \"profile-property\",\n \"field\": \"phone\",\n \"filter\": {\n \"type\": \"string\",\n \"operator\": \"phone-country-code-in\",\n \"value\": [\"US\", \"GB\"]\n }\n }",
"enum": [
"phone-country-code-in",
"phone-country-code-not-in"
],
"type": "string"
},
"type": {
"enum": [
"string"
],
"type": "string"
},
"value": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"type",
"operator",
"value"
],
"type": "object"
},
"SubmitBackInStock": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/SubmitBackInStockProperties",
"nullable": true
},
"submit": {
"default": true,
"enum": [
true
],
"example": true,
"type": "boolean"
},
"type": {
"enum": [
"submit_back_in_stock"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SubmitBackInStockProperties": {
"properties": {
"list_id": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"SubmitOptInCode": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"enum": [
null
]
},
"submit": {
"default": true,
"enum": [
true
],
"example": true,
"type": "boolean"
},
"type": {
"enum": [
"submit_opt_in_code"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"SubscribeViaSMS": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/SubscribeViaSMSProperties"
},
"submit": {
"default": true,
"enum": [
true
],
"example": true,
"type": "boolean"
},
"type": {
"enum": [
"subscribe_via_sms"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"SubscribeViaSMSProperties": {
"properties": {
"opt_in_keyword": {
"nullable": true,
"type": "string"
},
"opt_in_message": {
"type": "string"
},
"sending_number": {
"nullable": true,
"type": "string"
}
},
"required": [
"opt_in_keyword",
"opt_in_message",
"sending_number"
],
"type": "object"
},
"SubscribeViaWhatsApp": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/SubscribeViaWhatsAppProperties"
},
"submit": {
"default": true,
"enum": [
true
],
"example": true,
"type": "boolean"
},
"type": {
"enum": [
"subscribe_via_whatsapp"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"SubscribeViaWhatsAppProperties": {
"properties": {
"opt_in_keyword": {
"nullable": true,
"type": "string"
},
"opt_in_message": {
"type": "string"
},
"sending_number": {
"nullable": true,
"type": "string"
}
},
"required": [
"opt_in_keyword",
"opt_in_message",
"sending_number"
],
"type": "object"
},
"SubscribedSMSIsRcsCapableFilter": {
"properties": {
"field": {
"enum": [
"is_rcs_capable"
],
"type": "string"
},
"filter": {
"$ref": "#/components/schemas/BooleanFilter"
}
},
"required": [
"field",
"filter"
],
"type": "object"
},
"SubscriptionChannels": {
"properties": {
"email": {
"$ref": "#/components/schemas/EmailSubscriptionParameters",
"description": "The subscription parameters to subscribe to on the \"EMAIL\" Channel.",
"nullable": true
},
"push": {
"$ref": "#/components/schemas/PushSubscriptionParameters",
"description": "The subscription parameters to subscribe to on the \"Push\" Channel.",
"nullable": true
},
"sms": {
"$ref": "#/components/schemas/SMSSubscriptionParameters",
"description": "The subscription parameters to subscribe to on the \"SMS\" Channel.",
"nullable": true
},
"whatsapp": {
"$ref": "#/components/schemas/WhatsAppSubscriptionParameters",
"description": "The subscription parameters to subscribe to on the \"WhatsApp\" Channel.",
"nullable": true
}
},
"type": "object"
},
"SubscriptionCreateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/SubscriptionCreateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"SubscriptionCreateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"custom_source": {
"description": "A custom method detail or source to store on the consent records.",
"example": "Marketing Event",
"nullable": true,
"type": "string"
},
"historical_import": {
"default": false,
"description": "Whether this subscription is part of a historical import. If true, the consented_at field must be provided for each profile.",
"nullable": true,
"type": "boolean"
},
"profiles": {
"description": "The profile(s) to subscribe",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProfileSubscriptionCreateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"profiles"
],
"type": "object"
},
"relationships": {
"properties": {
"list": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The list to add the newly subscribed profiles to",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileSubscriptionBulkCreateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"SubscriptionDeleteJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/SubscriptionDeleteJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"SubscriptionDeleteJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"profiles": {
"description": "The profile(s) to unsubscribe",
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProfileSubscriptionDeleteQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"required": [
"profiles"
],
"type": "object"
},
"relationships": {
"properties": {
"list": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The list to remove the profiles from",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileSubscriptionBulkDeleteJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"SubscriptionEnum": {
"enum": [
"subscription"
],
"type": "string"
},
"SubscriptionParameters": {
"properties": {
"consent": {
"description": "The Consent status to be set as part of the subscribe call. Currently supports \"SUBSCRIBED\".",
"enum": [
"SUBSCRIBED"
],
"example": "SUBSCRIBED",
"type": "string"
},
"consented_at": {
"description": "The timestamp of when the profile's consent was gathered. This should only be used when syncing over historical consent info to Klaviyo; if the `historical_import` flag is not included, providing any value for this field will raise an error.",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"consent"
],
"type": "object"
},
"Subscriptions": {
"properties": {
"email": {
"$ref": "#/components/schemas/EmailChannel",
"description": "The email channel subscription.",
"nullable": true
},
"mobile_push": {
"$ref": "#/components/schemas/PushChannel",
"description": "The mobile push channel subscription.",
"nullable": true
},
"sms": {
"$ref": "#/components/schemas/SMSChannel",
"description": "The SMS channel subscription.",
"nullable": true
},
"whatsapp": {
"$ref": "#/components/schemas/WhatsappChannel",
"description": "The whatsapp channel subscription.",
"nullable": true
}
},
"type": "object"
},
"SuppressionCreateJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/SuppressionCreateJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"SuppressionCreateJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"profiles": {
"description": "The profile(s) to create suppressions for.",
"nullable": true,
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProfileSuppressionCreateQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"type": "object"
},
"relationships": {
"properties": {
"list": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Suppress all profiles in this list",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
},
"segment": {
"properties": {
"data": {
"properties": {
"id": {
"description": "Suppress all profiles in this segment",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileSuppressionBulkCreateJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"SuppressionDeleteJobCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/SuppressionDeleteJobCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"SuppressionDeleteJobCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"profiles": {
"description": "The profile(s) to remove suppressions for.",
"nullable": true,
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/ProfileSuppressionDeleteQueryResourceObject"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
}
},
"type": "object"
},
"relationships": {
"properties": {
"list": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The list to pull the profiles to remove suppressions from",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
},
"segment": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The segment to pull the profiles to remove suppressions from",
"example": "Y6nRLr",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/ProfileSuppressionBulkDeleteJobEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"TableBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"properties": {
"oneOf": [
{
"$ref": "#/components/schemas/StaticTableBlockProperties"
},
{
"$ref": "#/components/schemas/DynamicTableBlockProperties"
}
]
},
"styles": {
"$ref": "#/components/schemas/TableBlockStyles"
}
},
"required": [
"properties",
"display_options",
"styles"
],
"type": "object"
},
"TableBlockStyles": {
"properties": {
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_border_color": {
"nullable": true,
"type": "string"
},
"block_border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"block_border_width": {
"nullable": true,
"type": "integer"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"cell_horizontal_border_color": {
"nullable": true,
"type": "string"
},
"cell_horizontal_border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"cell_horizontal_border_width": {
"nullable": true,
"type": "integer"
},
"cell_padding_bottom": {
"nullable": true,
"type": "integer"
},
"cell_padding_left": {
"nullable": true,
"type": "integer"
},
"cell_padding_right": {
"nullable": true,
"type": "integer"
},
"cell_padding_top": {
"nullable": true,
"type": "integer"
},
"cell_vertical_align": {
"description": "Vertical alignment.",
"enum": [
"baseline",
"bottom",
"middle",
"top"
],
"nullable": true,
"type": "string"
},
"cell_vertical_border_color": {
"nullable": true,
"type": "string"
},
"cell_vertical_border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"cell_vertical_border_width": {
"nullable": true,
"type": "integer"
},
"header_background_color": {
"nullable": true,
"type": "string"
},
"header_font_color": {
"nullable": true,
"type": "string"
},
"header_font_family": {
"nullable": true,
"type": "string"
},
"header_font_size": {
"nullable": true,
"type": "integer"
},
"header_font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"header_font_weight": {
"nullable": true,
"type": "string"
},
"header_letter_spacing": {
"nullable": true,
"type": "integer"
},
"header_line_height": {
"nullable": true,
"type": "number"
},
"header_padding_bottom": {
"nullable": true,
"type": "integer"
},
"header_padding_left": {
"nullable": true,
"type": "integer"
},
"header_padding_right": {
"nullable": true,
"type": "integer"
},
"header_padding_top": {
"nullable": true,
"type": "integer"
},
"header_text_decoration": {
"nullable": true,
"type": "string"
},
"table_background_color": {
"nullable": true,
"type": "string"
},
"table_font_color": {
"nullable": true,
"type": "string"
},
"table_font_family": {
"nullable": true,
"type": "string"
},
"table_font_size": {
"nullable": true,
"type": "integer"
},
"table_text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"use_legacy_mobile_padding": {
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"TableBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"type": {
"enum": [
"table"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"TableBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/TableBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"subblocks": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/TableHeaderSubBlock"
},
{
"$ref": "#/components/schemas/TableHtmlSubBlock"
},
{
"$ref": "#/components/schemas/TableImageSubBlock"
},
{
"$ref": "#/components/schemas/TableTextSubBlock"
},
{
"$ref": "#/components/schemas/TableFallbackHtmlSubBlock"
},
{
"$ref": "#/components/schemas/TableFallbackImageSubBlock"
},
{
"$ref": "#/components/schemas/TableFallbackTextSubBlock"
}
]
},
"nullable": true,
"type": "array"
},
"type": {
"enum": [
"table"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"TableFallbackHtmlSubBlock": {
"properties": {
"content": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"table_fallback_html"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"TableFallbackImageSubBlock": {
"properties": {
"alt_text": {
"nullable": true,
"type": "string"
},
"asset_id": {
"nullable": true,
"type": "string"
},
"cell_text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"cropped_asset_id": {
"nullable": true,
"type": "string"
},
"cropped_src": {
"nullable": true,
"type": "string"
},
"cropping_aspect_ratio": {
"nullable": true,
"type": "string"
},
"cropping_height": {
"nullable": true,
"type": "integer"
},
"cropping_width": {
"nullable": true,
"type": "integer"
},
"cropping_x": {
"nullable": true,
"type": "integer"
},
"cropping_y": {
"nullable": true,
"type": "integer"
},
"dynamic": {
"nullable": true,
"type": "boolean"
},
"height": {
"nullable": true,
"type": "integer"
},
"href": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"image_align": {
"description": "Image Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"image_width": {
"nullable": true,
"type": "integer"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"src": {
"nullable": true,
"type": "string"
},
"table_column_width": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"table_fallback_image"
],
"type": "string"
},
"width": {
"nullable": true,
"type": "integer"
}
},
"required": [
"type"
],
"type": "object"
},
"TableFallbackTextSubBlock": {
"properties": {
"cell_text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"color": {
"nullable": true,
"type": "string"
},
"content": {
"nullable": true,
"type": "string"
},
"font_family": {
"nullable": true,
"type": "string"
},
"font_size": {
"nullable": true,
"type": "integer"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"letter_spacing": {
"nullable": true,
"type": "integer"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"table_column_width": {
"nullable": true,
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"table_fallback_text"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"TableHeaderSubBlock": {
"properties": {
"cell_text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"color": {
"nullable": true,
"type": "string"
},
"content": {
"nullable": true,
"type": "string"
},
"font_family": {
"nullable": true,
"type": "string"
},
"font_size": {
"nullable": true,
"type": "integer"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"letter_spacing": {
"nullable": true,
"type": "integer"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"table_column_width": {
"nullable": true,
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"table_header"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"TableHtmlSubBlock": {
"properties": {
"content": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"table_html"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"TableImageSubBlock": {
"properties": {
"alt_text": {
"nullable": true,
"type": "string"
},
"asset_id": {
"nullable": true,
"type": "string"
},
"cell_text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"cropped_asset_id": {
"nullable": true,
"type": "string"
},
"cropped_src": {
"nullable": true,
"type": "string"
},
"cropping_aspect_ratio": {
"nullable": true,
"type": "string"
},
"cropping_height": {
"nullable": true,
"type": "integer"
},
"cropping_width": {
"nullable": true,
"type": "integer"
},
"cropping_x": {
"nullable": true,
"type": "integer"
},
"cropping_y": {
"nullable": true,
"type": "integer"
},
"dynamic": {
"nullable": true,
"type": "boolean"
},
"height": {
"nullable": true,
"type": "integer"
},
"href": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"image_align": {
"description": "Image Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"image_width": {
"nullable": true,
"type": "integer"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"src": {
"nullable": true,
"type": "string"
},
"table_column_width": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"table_image"
],
"type": "string"
},
"width": {
"nullable": true,
"type": "integer"
}
},
"required": [
"type"
],
"type": "object"
},
"TableTextSubBlock": {
"properties": {
"cell_text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"color": {
"nullable": true,
"type": "string"
},
"content": {
"nullable": true,
"type": "string"
},
"font_family": {
"nullable": true,
"type": "string"
},
"font_size": {
"nullable": true,
"type": "integer"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"letter_spacing": {
"nullable": true,
"type": "integer"
},
"show_on": {
"description": "Show on.",
"enum": [
"all",
"desktop",
"mobile"
],
"nullable": true,
"type": "string"
},
"table_column_width": {
"nullable": true,
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
},
"type": {
"enum": [
"table_text"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"TagCampaignOp": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The IDs of the campaigns to link or unlink with the given Tag ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"TagCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/TagCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"TagCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"name": {
"description": "The Tag name",
"example": "My Tag",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"relationships": {
"properties": {
"tag-group": {
"properties": {
"data": {
"properties": {
"id": {
"description": "The ID of the Tag Group to associate the Tag with. If this field is not specified, the Tag will be associated with the company's Default Tag Group.",
"example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagGroupEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"TagEnum": {
"enum": [
"tag"
],
"type": "string"
},
"TagFlowOp": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The IDs of the flows to link or unlink with the given Tag ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"TagGroupCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/TagGroupCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"TagGroupCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"exclusive": {
"default": false,
"nullable": true,
"type": "boolean"
},
"name": {
"description": "The Tag Group name",
"example": "My Tag Group",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/TagGroupEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"TagGroupEnum": {
"enum": [
"tag-group"
],
"type": "string"
},
"TagGroupResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"default": {
"description": "Every company automatically has one Default Tag Group. The Default Tag Group cannot be deleted, and no other Default Tag Groups can be created. This value is true for the Default Tag Group and false for all other Tag Groups.",
"type": "boolean"
},
"exclusive": {
"description": "If a tag group is non-exclusive, any given related resource (campaign, flow, etc.) can be linked to multiple tags from that tag group. If a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.",
"type": "boolean"
},
"name": {
"description": "The Tag Group name",
"example": "My Tag Group",
"type": "string"
}
},
"required": [
"name",
"exclusive",
"default"
],
"type": "object"
},
"id": {
"description": "The Tag Group ID",
"example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"tags": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/TagGroupEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"TagGroupUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/TagGroupUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"TagGroupUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"name": {
"description": "The Tag Group name",
"example": "My Tag Group",
"type": "string"
},
"return_fields": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"required": [
"name"
],
"type": "object"
},
"id": {
"description": "The Tag Group ID",
"example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagGroupEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"TagListOp": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The IDs of the lists to link or unlink with the given Tag ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"TagResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"name": {
"description": "The Tag name",
"example": "My Tag",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"id": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"campaigns": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/CampaignEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"flows": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/FlowEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"lists": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/ListEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"segments": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
},
"tag-group": {
"properties": {
"data": {
"properties": {
"id": {
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagGroupEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"TagSegmentOp": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "The IDs of the segments to link or unlink with the given Tag ID",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/SegmentEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"TagUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/TagUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"TagUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"name": {
"description": "The Tag name",
"example": "My Tag",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"id": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TagEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"TargetDateAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/TargetDateActionData"
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"target-date"
],
"type": "string"
}
},
"required": [
"type",
"data"
],
"type": "object"
},
"TargetDateActionData": {
"properties": {
"target_days": {
"items": {
"description": "Days of the week.",
"enum": [
"friday",
"monday",
"saturday",
"sunday",
"thursday",
"tuesday",
"wednesday"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"target_time": {
"format": "time",
"type": "string"
},
"timezone": {
"default": "profile",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC",
"profile"
],
"example": "profile",
"type": "string"
}
},
"type": "object"
},
"Teaser": {
"properties": {
"close_button": {
"default": true,
"example": true,
"type": "boolean"
},
"content": {
"type": "string"
},
"custom_size": {
"nullable": true,
"type": "integer"
},
"device_type": {
"default": "both",
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"example": "both",
"type": "string"
},
"display_order": {
"default": "after",
"description": "Teaser display order enumeration.",
"enum": [
"after",
"before",
"before_and_after"
],
"example": "after",
"type": "string"
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"location": {
"default": "bottom_left",
"description": "Display location enumeration.",
"enum": [
"bottom_center",
"bottom_left",
"bottom_right",
"center_left",
"center_right",
"top_center",
"top_left",
"top_right"
],
"example": "bottom_left",
"type": "string"
},
"size": {
"default": "small",
"description": "Teaser size enumeration.",
"enum": [
"custom",
"large",
"medium",
"small"
],
"example": "small",
"type": "string"
},
"styles": {
"$ref": "#/components/schemas/TeaserStyles"
},
"teaser_type": {
"default": "rectangle",
"description": "Teaser display order enumeration.",
"enum": [
"circle",
"corner",
"rectangle"
],
"example": "rectangle",
"type": "string"
}
},
"required": [
"content"
],
"type": "object"
},
"TeaserStyles": {
"properties": {
"background_color": {
"default": "#FFFFFF",
"example": "#FFFFFF",
"type": "string"
},
"background_image": {
"$ref": "#/components/schemas/BackgroundImage",
"nullable": true
},
"close_button": {
"$ref": "#/components/schemas/CloseButtonStyle"
},
"corner_radius": {
"default": 4,
"example": 4,
"type": "integer"
},
"drop_shadow": {
"$ref": "#/components/schemas/DropShadow"
},
"margin": {
"$ref": "#/components/schemas/Margin"
}
},
"type": "object"
},
"TemplateCloneQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/TemplateCloneQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"TemplateCloneQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"name": {
"description": "The name of the template",
"example": "Clone of Monthly Newsletter Template",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The ID of template to be cloned",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"TemplateCreateHtmlOrDndQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/TemplateCreateHtmlOrDndQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"TemplateCreateHtmlOrDndQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"amp": {
"description": "The AMP version of the template. Requires AMP Email to be enabled to access in-app. Refer to the AMP Email setup guide at https://developers.klaviyo.com/en/docs/send_amp_emails_in_klaviyo Not allowed for SYSTEM_DRAGGABLE.",
"nullable": true,
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/TemplateDefinition",
"description": "The template definition. Required for SYSTEM_DRAGGABLE; ignored for CODE/USER_DRAGGABLE.",
"nullable": true
},
"editor_type": {
"description": "Restricted to CODE, USER_DRAGGABLE, or SYSTEM_DRAGGABLE",
"type": "string"
},
"html": {
"description": "The HTML contents of the template. Required for CODE/USER_DRAGGABLE; not allowed for SYSTEM_DRAGGABLE.",
"nullable": true,
"type": "string"
},
"name": {
"description": "The name of the template",
"example": "Monthly Newsletter Template",
"type": "string"
},
"text": {
"description": "The plaintext version of the template",
"example": "hello world",
"nullable": true,
"type": "string"
}
},
"required": [
"name",
"editor_type"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"TemplateDefinition": {
"properties": {
"body": {
"$ref": "#/components/schemas/Body"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"styles": {
"description": "When present, must contain exactly one of each style type.",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/BaseStyle"
},
{
"$ref": "#/components/schemas/TextStyleV1"
},
{
"$ref": "#/components/schemas/Heading1Style"
},
{
"$ref": "#/components/schemas/Heading2Style"
},
{
"$ref": "#/components/schemas/Heading3Style"
},
{
"$ref": "#/components/schemas/Heading4Style"
},
{
"$ref": "#/components/schemas/LinkStyle"
},
{
"$ref": "#/components/schemas/MobileStyle"
}
]
},
"type": "array"
},
"template_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"body",
"styles"
],
"type": "object"
},
"TemplateDndResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"amp": {
"description": "The AMP version of the template. Requires AMP Email to be enabled to access in-app. Refer to the AMP Email setup guide at https://developers.klaviyo.com/en/docs/send_amp_emails_in_klaviyo",
"nullable": true,
"type": "string"
},
"created": {
"description": "The date the template was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"editor_type": {
"description": "`editor_type` has a fixed set of values:\n* SYSTEM_DRAGGABLE: indicates a drag-and-drop editor template\n* SIMPLE: A rich text editor template\n* CODE: A custom HTML template\n* USER_DRAGGABLE: A hybrid template, using custom HTML in the drag-and-drop editor",
"type": "string"
},
"html": {
"description": "The rendered HTML of the template",
"type": "string"
},
"name": {
"description": "The name of the template",
"type": "string"
},
"text": {
"description": "The template plain_text",
"nullable": true,
"type": "string"
},
"updated": {
"description": "The date the template was updated in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"name",
"editor_type",
"html"
],
"type": "object"
},
"id": {
"description": "The ID of template",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"TemplateEnum": {
"enum": [
"template"
],
"type": "string"
},
"TemplateRenderQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/TemplateRenderQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"TemplateRenderQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"context": {
"description": "The context for the template render. This must be a JSON object which has values for any tags used in the template. See [this doc](https://help.klaviyo.com/hc/en-us/articles/4408802648731) for more details.",
"example": {
"first_name": "Jane",
"last_name": "Smith"
},
"type": "object"
}
},
"required": [
"context"
],
"type": "object"
},
"id": {
"description": "The ID of template",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"TemplateResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"amp": {
"description": "The AMP version of the template. Requires AMP Email to be enabled to access in-app. Refer to the AMP Email setup guide at https://developers.klaviyo.com/en/docs/send_amp_emails_in_klaviyo",
"nullable": true,
"type": "string"
},
"created": {
"description": "The date the template was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"editor_type": {
"description": "`editor_type` has a fixed set of values:\n* SYSTEM_DRAGGABLE: indicates a drag-and-drop editor template\n* SIMPLE: A rich text editor template\n* CODE: A custom HTML template\n* USER_DRAGGABLE: A hybrid template, using custom HTML in the drag-and-drop editor",
"type": "string"
},
"html": {
"description": "The rendered HTML of the template",
"type": "string"
},
"name": {
"description": "The name of the template",
"type": "string"
},
"text": {
"description": "The template plain_text",
"nullable": true,
"type": "string"
},
"updated": {
"description": "The date the template was updated in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"name",
"editor_type",
"html"
],
"type": "object"
},
"id": {
"description": "The ID of template",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"TemplateUniversalContentEnum": {
"enum": [
"template-universal-content"
],
"type": "string"
},
"TemplateUpdateHtmlOrDndQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/TemplateUpdateHtmlOrDndQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"TemplateUpdateHtmlOrDndQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"amp": {
"description": "The AMP version of the template. Requires AMP Email to be enabled to access in-app. Refer to the AMP Email setup guide at https://developers.klaviyo.com/en/docs/send_amp_emails_in_klaviyo Not allowed for SYSTEM_DRAGGABLE.",
"nullable": true,
"type": "string"
},
"definition": {
"$ref": "#/components/schemas/TemplateDefinition",
"description": "The template definition for SYSTEM_DRAGGABLE templates. Entirely replaces the existing definition. Not allowed for CODE/USER_DRAGGABLE.",
"nullable": true
},
"html": {
"description": "The HTML contents of the template. Not allowed for SYSTEM_DRAGGABLE templates.",
"example": "\n \n \n hello world\n \n \n ",
"nullable": true,
"type": "string"
},
"name": {
"description": "The name of the template",
"example": "Monthly Newsletter Template",
"nullable": true,
"type": "string"
},
"text": {
"description": "The plaintext of the template",
"example": "hello world",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The ID of template",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"Text": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/TextProperties"
},
"styles": {
"$ref": "#/components/schemas/TextStyles"
},
"type": {
"enum": [
"text"
],
"type": "string"
}
},
"required": [
"type",
"properties"
],
"type": "object"
},
"TextBlockDataV0": {
"properties": {
"content": {
"type": "string"
},
"display_options": {
"$ref": "#/components/schemas/BlockDisplayOptions"
},
"styles": {
"$ref": "#/components/schemas/TextBlockStylesV0"
}
},
"required": [
"content",
"display_options",
"styles"
],
"type": "object"
},
"TextBlockDataV1": {
"properties": {
"content": {
"type": "string"
},
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"styles": {
"$ref": "#/components/schemas/TextBlockStylesV1"
}
},
"required": [
"content",
"display_options",
"styles"
],
"type": "object"
},
"TextBlockStylesV0": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_border_color": {
"nullable": true,
"type": "string"
},
"block_border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"block_border_width": {
"nullable": true,
"type": "integer"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"color": {
"nullable": true,
"type": "string"
},
"extra_css_class": {
"nullable": true,
"type": "string"
},
"font_family": {
"nullable": true,
"type": "string"
},
"font_size": {
"nullable": true,
"type": "integer"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"inner_padding_bottom": {
"nullable": true,
"type": "integer"
},
"inner_padding_left": {
"nullable": true,
"type": "integer"
},
"inner_padding_right": {
"nullable": true,
"type": "integer"
},
"inner_padding_top": {
"nullable": true,
"type": "integer"
},
"letter_spacing": {
"nullable": true,
"type": "integer"
},
"line_height": {
"nullable": true,
"type": "number"
},
"mobile_stretch_content": {
"nullable": true,
"type": "boolean"
},
"text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
},
"text_table_layout": {
"description": "Text table layout.",
"enum": [
"auto",
"fixed",
"inherit",
"initial"
],
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"TextBlockStylesV1": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_border_color": {
"nullable": true,
"type": "string"
},
"block_border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"block_border_width": {
"nullable": true,
"type": "integer"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"color": {
"nullable": true,
"type": "string"
},
"extra_css_class": {
"nullable": true,
"type": "string"
},
"font_family": {
"nullable": true,
"type": "string"
},
"font_size": {
"nullable": true,
"type": "integer"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"inner_padding_bottom": {
"nullable": true,
"type": "integer"
},
"inner_padding_left": {
"nullable": true,
"type": "integer"
},
"inner_padding_right": {
"nullable": true,
"type": "integer"
},
"inner_padding_top": {
"nullable": true,
"type": "integer"
},
"letter_spacing": {
"nullable": true,
"type": "integer"
},
"line_height": {
"nullable": true,
"type": "number"
},
"mobile_stretch_content": {
"nullable": true,
"type": "boolean"
},
"text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
},
"text_table_layout": {
"description": "Text table layout.",
"enum": [
"auto",
"fixed",
"inherit",
"initial"
],
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"TextBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/TextBlockDataV0"
},
"type": {
"enum": [
"text"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"TextBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/TextBlockDataV1"
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"text"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"TextProperties": {
"properties": {
"classname": {
"nullable": true,
"type": "string"
},
"display_device": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"type": "array"
},
"error_messages": {
"$ref": "#/components/schemas/ErrorMessages",
"nullable": true
},
"label": {
"nullable": true,
"type": "string"
},
"placeholder": {
"nullable": true,
"type": "string"
},
"property_name": {
"type": "string"
},
"required": {
"default": false,
"nullable": true,
"type": "boolean"
},
"show_label": {
"default": false,
"type": "boolean"
}
},
"required": [
"property_name"
],
"type": "object"
},
"TextStyleStyles": {
"properties": {
"color": {
"nullable": true,
"type": "string"
},
"font_family": {
"nullable": true,
"type": "string"
},
"font_size": {
"nullable": true,
"type": "integer"
},
"font_style": {
"description": "Font style.",
"enum": [
"italic",
"normal"
],
"nullable": true,
"type": "string"
},
"font_weight": {
"nullable": true,
"type": "string"
},
"letter_spacing": {
"nullable": true,
"type": "integer"
},
"line_height": {
"nullable": true,
"type": "number"
},
"mobile_font_size": {
"nullable": true,
"type": "integer"
},
"mobile_line_height": {
"nullable": true,
"type": "number"
},
"text_align": {
"description": "Text Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"TextStyleV0": {
"properties": {
"character_spacing": {
"default": 0,
"nullable": true,
"type": "integer"
},
"font_family": {
"default": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"example": "Arial, 'Helvetica Neue', Helvetica, sans-serif",
"oneOf": [
{
"description": "Web safe font enumeration.",
"enum": [
"Arial Black,Arial",
"Arial, 'Helvetica Neue', Helvetica, sans-serif",
"Century Gothic,AppleGothic,Arial",
"Comic Sans MS,Comic Sans,cursive",
"Courier",
"Courier New",
"Geneva,Arial",
"Georgia",
"Helvetica,Arial",
"Lucida Grande,Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"Lucida,Lucida Sans Unicode,Lucida Sans,Geneva,Verdana,sans-serif",
"MS Serif,Georgia",
"New York,Georgia",
"Palatino Linotype,Palatino,Georgia",
"Palatino,Georgia",
"Tahoma,sans-serif",
"Times New Roman",
"Trebuchet MS",
"Verdana"
],
"type": "string"
},
{
"type": "string"
}
]
},
"font_size": {
"default": 16,
"example": 16,
"type": "integer"
},
"font_style": {
"nullable": true,
"type": "string"
},
"font_weight": {
"default": 400,
"description": "Font weight enumeration.",
"enum": [
100,
200,
300,
400,
500,
600,
700,
800,
900
],
"example": 400,
"nullable": true,
"type": "integer"
},
"text_color": {
"default": "#000000",
"example": "#000000",
"type": "string"
},
"text_decoration": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"TextStyleV1": {
"properties": {
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"style_type": {
"enum": [
"text-styles"
],
"type": "string"
},
"styles": {
"$ref": "#/components/schemas/TextStyleStyles"
}
},
"required": [
"style_type",
"styles"
],
"type": "object"
},
"TextStyles": {
"properties": {
"background_color": {
"nullable": true,
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
}
},
"type": "object"
},
"ThrottledSendStrategy": {
"properties": {
"datetime": {
"description": "The time to send at",
"format": "date-time",
"type": "string"
},
"method": {
"enum": [
"throttled"
],
"type": "string"
},
"throttle_percentage": {
"description": "The percentage of recipients per hour to send to.",
"enum": [
10,
11,
13,
14,
17,
20,
25,
33,
50
],
"type": "integer"
}
},
"required": [
"method",
"datetime",
"throttle_percentage"
],
"type": "object"
},
"TimeDelayAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/TimeDelayActionData"
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"time-delay"
],
"type": "string"
}
},
"required": [
"type",
"data"
],
"type": "object"
},
"TimeDelayActionData": {
"properties": {
"delay_until_time": {
"format": "time",
"nullable": true,
"type": "string"
},
"delay_until_weekdays": {
"items": {
"description": "Days of the week.",
"enum": [
"friday",
"monday",
"saturday",
"sunday",
"thursday",
"tuesday",
"wednesday"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"secondary_value": {
"nullable": true,
"type": "integer"
},
"timezone": {
"default": "profile",
"enum": [
"Africa/Abidjan",
"Africa/Accra",
"Africa/Addis_Ababa",
"Africa/Algiers",
"Africa/Asmara",
"Africa/Bamako",
"Africa/Bangui",
"Africa/Banjul",
"Africa/Bissau",
"Africa/Blantyre",
"Africa/Brazzaville",
"Africa/Bujumbura",
"Africa/Cairo",
"Africa/Casablanca",
"Africa/Ceuta",
"Africa/Conakry",
"Africa/Dakar",
"Africa/Dar_es_Salaam",
"Africa/Djibouti",
"Africa/Douala",
"Africa/El_Aaiun",
"Africa/Freetown",
"Africa/Gaborone",
"Africa/Harare",
"Africa/Johannesburg",
"Africa/Juba",
"Africa/Kampala",
"Africa/Khartoum",
"Africa/Kigali",
"Africa/Kinshasa",
"Africa/Lagos",
"Africa/Libreville",
"Africa/Lome",
"Africa/Luanda",
"Africa/Lubumbashi",
"Africa/Lusaka",
"Africa/Malabo",
"Africa/Maputo",
"Africa/Maseru",
"Africa/Mbabane",
"Africa/Mogadishu",
"Africa/Monrovia",
"Africa/Nairobi",
"Africa/Ndjamena",
"Africa/Niamey",
"Africa/Nouakchott",
"Africa/Ouagadougou",
"Africa/Porto-Novo",
"Africa/Sao_Tome",
"Africa/Tripoli",
"Africa/Tunis",
"Africa/Windhoek",
"America/Adak",
"America/Anchorage",
"America/Anguilla",
"America/Antigua",
"America/Araguaina",
"America/Argentina/Buenos_Aires",
"America/Argentina/Catamarca",
"America/Argentina/Cordoba",
"America/Argentina/Jujuy",
"America/Argentina/La_Rioja",
"America/Argentina/Mendoza",
"America/Argentina/Rio_Gallegos",
"America/Argentina/Salta",
"America/Argentina/San_Juan",
"America/Argentina/San_Luis",
"America/Argentina/Tucuman",
"America/Argentina/Ushuaia",
"America/Aruba",
"America/Asuncion",
"America/Atikokan",
"America/Bahia",
"America/Bahia_Banderas",
"America/Barbados",
"America/Belem",
"America/Belize",
"America/Blanc-Sablon",
"America/Boa_Vista",
"America/Bogota",
"America/Boise",
"America/Cambridge_Bay",
"America/Campo_Grande",
"America/Cancun",
"America/Caracas",
"America/Cayenne",
"America/Cayman",
"America/Chicago",
"America/Chihuahua",
"America/Ciudad_Juarez",
"America/Costa_Rica",
"America/Creston",
"America/Cuiaba",
"America/Curacao",
"America/Danmarkshavn",
"America/Dawson",
"America/Dawson_Creek",
"America/Denver",
"America/Detroit",
"America/Dominica",
"America/Edmonton",
"America/Eirunepe",
"America/El_Salvador",
"America/Fort_Nelson",
"America/Fortaleza",
"America/Glace_Bay",
"America/Goose_Bay",
"America/Grand_Turk",
"America/Grenada",
"America/Guadeloupe",
"America/Guatemala",
"America/Guayaquil",
"America/Guyana",
"America/Halifax",
"America/Havana",
"America/Hermosillo",
"America/Indiana/Indianapolis",
"America/Indiana/Knox",
"America/Indiana/Marengo",
"America/Indiana/Petersburg",
"America/Indiana/Tell_City",
"America/Indiana/Vevay",
"America/Indiana/Vincennes",
"America/Indiana/Winamac",
"America/Inuvik",
"America/Iqaluit",
"America/Jamaica",
"America/Juneau",
"America/Kentucky/Louisville",
"America/Kentucky/Monticello",
"America/Kralendijk",
"America/La_Paz",
"America/Lima",
"America/Los_Angeles",
"America/Lower_Princes",
"America/Maceio",
"America/Managua",
"America/Manaus",
"America/Marigot",
"America/Martinique",
"America/Matamoros",
"America/Mazatlan",
"America/Menominee",
"America/Merida",
"America/Metlakatla",
"America/Mexico_City",
"America/Miquelon",
"America/Moncton",
"America/Monterrey",
"America/Montevideo",
"America/Montserrat",
"America/Nassau",
"America/New_York",
"America/Nome",
"America/Noronha",
"America/North_Dakota/Beulah",
"America/North_Dakota/Center",
"America/North_Dakota/New_Salem",
"America/Nuuk",
"America/Ojinaga",
"America/Panama",
"America/Paramaribo",
"America/Phoenix",
"America/Port-au-Prince",
"America/Port_of_Spain",
"America/Porto_Velho",
"America/Puerto_Rico",
"America/Punta_Arenas",
"America/Rankin_Inlet",
"America/Recife",
"America/Regina",
"America/Resolute",
"America/Rio_Branco",
"America/Santarem",
"America/Santiago",
"America/Santo_Domingo",
"America/Sao_Paulo",
"America/Scoresbysund",
"America/Sitka",
"America/St_Barthelemy",
"America/St_Johns",
"America/St_Kitts",
"America/St_Lucia",
"America/St_Thomas",
"America/St_Vincent",
"America/Swift_Current",
"America/Tegucigalpa",
"America/Thule",
"America/Tijuana",
"America/Toronto",
"America/Tortola",
"America/Vancouver",
"America/Whitehorse",
"America/Winnipeg",
"America/Yakutat",
"Antarctica/Casey",
"Antarctica/Davis",
"Antarctica/DumontDUrville",
"Antarctica/Macquarie",
"Antarctica/Mawson",
"Antarctica/McMurdo",
"Antarctica/Palmer",
"Antarctica/Rothera",
"Antarctica/Syowa",
"Antarctica/Troll",
"Antarctica/Vostok",
"Arctic/Longyearbyen",
"Asia/Aden",
"Asia/Almaty",
"Asia/Amman",
"Asia/Anadyr",
"Asia/Aqtau",
"Asia/Aqtobe",
"Asia/Ashgabat",
"Asia/Atyrau",
"Asia/Baghdad",
"Asia/Bahrain",
"Asia/Baku",
"Asia/Bangkok",
"Asia/Barnaul",
"Asia/Beirut",
"Asia/Bishkek",
"Asia/Brunei",
"Asia/Chita",
"Asia/Choibalsan",
"Asia/Colombo",
"Asia/Damascus",
"Asia/Dhaka",
"Asia/Dili",
"Asia/Dubai",
"Asia/Dushanbe",
"Asia/Famagusta",
"Asia/Gaza",
"Asia/Hebron",
"Asia/Ho_Chi_Minh",
"Asia/Hong_Kong",
"Asia/Hovd",
"Asia/Irkutsk",
"Asia/Jakarta",
"Asia/Jayapura",
"Asia/Jerusalem",
"Asia/Kabul",
"Asia/Kamchatka",
"Asia/Karachi",
"Asia/Kathmandu",
"Asia/Khandyga",
"Asia/Kolkata",
"Asia/Krasnoyarsk",
"Asia/Kuala_Lumpur",
"Asia/Kuching",
"Asia/Kuwait",
"Asia/Macau",
"Asia/Magadan",
"Asia/Makassar",
"Asia/Manila",
"Asia/Muscat",
"Asia/Nicosia",
"Asia/Novokuznetsk",
"Asia/Novosibirsk",
"Asia/Omsk",
"Asia/Oral",
"Asia/Phnom_Penh",
"Asia/Pontianak",
"Asia/Pyongyang",
"Asia/Qatar",
"Asia/Qostanay",
"Asia/Qyzylorda",
"Asia/Riyadh",
"Asia/Sakhalin",
"Asia/Samarkand",
"Asia/Seoul",
"Asia/Shanghai",
"Asia/Singapore",
"Asia/Srednekolymsk",
"Asia/Taipei",
"Asia/Tashkent",
"Asia/Tbilisi",
"Asia/Tehran",
"Asia/Thimphu",
"Asia/Tokyo",
"Asia/Tomsk",
"Asia/Ulaanbaatar",
"Asia/Urumqi",
"Asia/Ust-Nera",
"Asia/Vientiane",
"Asia/Vladivostok",
"Asia/Yakutsk",
"Asia/Yangon",
"Asia/Yekaterinburg",
"Asia/Yerevan",
"Atlantic/Azores",
"Atlantic/Bermuda",
"Atlantic/Canary",
"Atlantic/Cape_Verde",
"Atlantic/Faroe",
"Atlantic/Madeira",
"Atlantic/Reykjavik",
"Atlantic/South_Georgia",
"Atlantic/St_Helena",
"Atlantic/Stanley",
"Australia/Adelaide",
"Australia/Brisbane",
"Australia/Broken_Hill",
"Australia/Darwin",
"Australia/Eucla",
"Australia/Hobart",
"Australia/Lindeman",
"Australia/Lord_Howe",
"Australia/Melbourne",
"Australia/Perth",
"Australia/Sydney",
"Canada/Atlantic",
"Canada/Central",
"Canada/Eastern",
"Canada/Mountain",
"Canada/Newfoundland",
"Canada/Pacific",
"Europe/Amsterdam",
"Europe/Andorra",
"Europe/Astrakhan",
"Europe/Athens",
"Europe/Belgrade",
"Europe/Berlin",
"Europe/Bratislava",
"Europe/Brussels",
"Europe/Bucharest",
"Europe/Budapest",
"Europe/Busingen",
"Europe/Chisinau",
"Europe/Copenhagen",
"Europe/Dublin",
"Europe/Gibraltar",
"Europe/Guernsey",
"Europe/Helsinki",
"Europe/Isle_of_Man",
"Europe/Istanbul",
"Europe/Jersey",
"Europe/Kaliningrad",
"Europe/Kirov",
"Europe/Kyiv",
"Europe/Lisbon",
"Europe/Ljubljana",
"Europe/London",
"Europe/Luxembourg",
"Europe/Madrid",
"Europe/Malta",
"Europe/Mariehamn",
"Europe/Minsk",
"Europe/Monaco",
"Europe/Moscow",
"Europe/Oslo",
"Europe/Paris",
"Europe/Podgorica",
"Europe/Prague",
"Europe/Riga",
"Europe/Rome",
"Europe/Samara",
"Europe/San_Marino",
"Europe/Sarajevo",
"Europe/Saratov",
"Europe/Simferopol",
"Europe/Skopje",
"Europe/Sofia",
"Europe/Stockholm",
"Europe/Tallinn",
"Europe/Tirane",
"Europe/Ulyanovsk",
"Europe/Vaduz",
"Europe/Vatican",
"Europe/Vienna",
"Europe/Vilnius",
"Europe/Volgograd",
"Europe/Warsaw",
"Europe/Zagreb",
"Europe/Zurich",
"GMT",
"Indian/Antananarivo",
"Indian/Chagos",
"Indian/Christmas",
"Indian/Cocos",
"Indian/Comoro",
"Indian/Kerguelen",
"Indian/Mahe",
"Indian/Maldives",
"Indian/Mauritius",
"Indian/Mayotte",
"Indian/Reunion",
"Pacific/Apia",
"Pacific/Auckland",
"Pacific/Bougainville",
"Pacific/Chatham",
"Pacific/Chuuk",
"Pacific/Easter",
"Pacific/Efate",
"Pacific/Fakaofo",
"Pacific/Fiji",
"Pacific/Funafuti",
"Pacific/Galapagos",
"Pacific/Gambier",
"Pacific/Guadalcanal",
"Pacific/Guam",
"Pacific/Honolulu",
"Pacific/Kanton",
"Pacific/Kiritimati",
"Pacific/Kosrae",
"Pacific/Kwajalein",
"Pacific/Majuro",
"Pacific/Marquesas",
"Pacific/Midway",
"Pacific/Nauru",
"Pacific/Niue",
"Pacific/Norfolk",
"Pacific/Noumea",
"Pacific/Pago_Pago",
"Pacific/Palau",
"Pacific/Pitcairn",
"Pacific/Pohnpei",
"Pacific/Port_Moresby",
"Pacific/Rarotonga",
"Pacific/Saipan",
"Pacific/Tahiti",
"Pacific/Tarawa",
"Pacific/Tongatapu",
"Pacific/Wake",
"Pacific/Wallis",
"US/Alaska",
"US/Arizona",
"US/Central",
"US/Eastern",
"US/Hawaii",
"US/Mountain",
"US/Pacific",
"UTC",
"profile"
],
"example": "profile",
"type": "string"
},
"unit": {
"default": "days",
"description": "aka delay_units in app.",
"enum": [
"days",
"hours",
"minutes"
],
"example": "days",
"type": "string"
},
"value": {
"type": "integer"
}
},
"required": [
"value"
],
"type": "object"
},
"Timeframe": {
"properties": {
"key": {
"description": "Pre-defined key that represents a set timeframe",
"enum": [
"last_12_months",
"last_30_days",
"last_365_days",
"last_3_months",
"last_7_days",
"last_90_days",
"last_month",
"last_week",
"last_year",
"this_month",
"this_week",
"this_year",
"today",
"yesterday"
],
"type": "string"
}
},
"required": [
"key"
],
"type": "object"
},
"TrackingParamDTO": {
"properties": {
"campaign": {
"description": "The value of the tracking parameter when applied to a campaign.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/CampaignTrackingSettingDynamicParam"
},
{
"$ref": "#/components/schemas/CampaignTrackingSettingStaticParam"
}
]
},
"flow": {
"description": "The value of the tracking parameter when applied to a flow.",
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/FlowTrackingSettingDynamicParam"
},
{
"$ref": "#/components/schemas/FlowTrackingSettingStaticParam"
}
]
}
},
"type": "object"
},
"TrackingSettingEnum": {
"enum": [
"tracking-setting"
],
"type": "string"
},
"TrackingSettingPartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/TrackingSettingPartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"TrackingSettingPartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"auto_add_parameters": {
"description": "Whether tracking parameters are automatically added to campaigns and flows.",
"nullable": true,
"type": "boolean"
},
"custom_parameters": {
"description": "List of custom tracking parameters.",
"items": {
"$ref": "#/components/schemas/CustomTrackingParamDTO"
},
"nullable": true,
"type": "array"
},
"utm_campaign": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_campaign tracking parameter.",
"nullable": true
},
"utm_id": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_id tracking parameter.",
"nullable": true
},
"utm_medium": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_medium tracking parameter.",
"nullable": true
},
"utm_source": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_source tracking parameter.",
"nullable": true
},
"utm_term": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_term tracking parameter.",
"nullable": true
}
},
"type": "object"
},
"id": {
"description": "The id of the tracking setting (account ID).",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TrackingSettingEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"TrackingSettingResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"auto_add_parameters": {
"description": "Whether tracking parameters are automatically added to campaigns and flows.",
"type": "boolean"
},
"custom_parameters": {
"description": "Additional custom tracking parameters.",
"items": {
"$ref": "#/components/schemas/CustomTrackingParamDTO"
},
"nullable": true,
"type": "array"
},
"utm_campaign": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_campaign tracking parameter.",
"nullable": true
},
"utm_id": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_id tracking parameter.",
"nullable": true
},
"utm_medium": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_medium tracking parameter."
},
"utm_source": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_source tracking parameter."
},
"utm_term": {
"$ref": "#/components/schemas/TrackingParamDTO",
"description": "The utm_term tracking parameter.",
"nullable": true
}
},
"required": [
"auto_add_parameters",
"utm_source",
"utm_medium"
],
"type": "object"
},
"id": {
"description": "The id of the tracking setting (account ID).",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/TrackingSettingEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"TriggerBaseProperties": {
"maxProperties": 0,
"type": "object"
},
"TriggerBranchAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/TriggerBranchActionData",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/BooleanBranchLinks",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"trigger-split"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"TriggerBranchActionData": {
"properties": {
"trigger_filter": {
"nullable": true,
"properties": {
"condition_groups": {
"items": {
"properties": {
"conditions": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/MetricPropertyCondition"
},
{
"$ref": "#/components/schemas/CustomObjectTriggerCondition"
},
{
"$ref": "#/components/schemas/CustomObjectPropertyCondition"
},
{
"$ref": "#/components/schemas/PriceDropCondition"
},
{
"$ref": "#/components/schemas/LowInventoryCondition"
}
]
},
"type": "array"
}
},
"required": [
"conditions"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"condition_groups"
],
"type": "object"
},
"trigger_id": {
"type": "string"
},
"trigger_subtype": {
"description": "Date trigger type.",
"enum": [
"custom-object",
"legacy-custom-object",
"profile-property",
"profile-trait"
],
"nullable": true,
"type": "string"
},
"trigger_type": {
"description": "Trigger type.",
"enum": [
"date",
"list",
"low-inventory",
"metric",
"price-drop",
"scheduled",
"segment"
],
"type": "string"
}
},
"required": [
"trigger_filter",
"trigger_id",
"trigger_type"
],
"type": "object"
},
"URLPatterns": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/URLPatternsProperties"
},
"type": {
"enum": [
"url_patterns"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"URLPatternsProperties": {
"properties": {
"allow_list": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
},
"deny_list": {
"items": {
"type": "string"
},
"nullable": true,
"type": "array"
}
},
"type": "object"
},
"UnidentifiedProfiles": {
"properties": {
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/TriggerBaseProperties"
},
"type": {
"enum": [
"unidentified_profiles"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"UniqueCouponConfig": {
"properties": {
"code": {
"nullable": true,
"type": "string"
},
"fallback_coupon_code": {
"nullable": true,
"type": "string"
},
"id": {
"nullable": true,
"type": "integer"
},
"integration": {
"default": "shopify",
"description": "Coupon integration types for unique coupon blocks.",
"enum": [
"api",
"magento_two",
"prestashop",
"shopify",
"uploaded",
"woocommerce"
],
"example": "shopify",
"type": "string"
},
"type": {
"enum": [
"unique"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"UniversalContentCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/UniversalContentCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"UniversalContentCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"definition": {
"oneOf": [
{
"$ref": "#/components/schemas/ButtonBlockV0"
},
{
"$ref": "#/components/schemas/DropShadowBlockV0"
},
{
"$ref": "#/components/schemas/HorizontalRuleBlockV0"
},
{
"$ref": "#/components/schemas/HTMLBlockV0"
},
{
"$ref": "#/components/schemas/ImageBlockV0"
},
{
"$ref": "#/components/schemas/SpacerBlockV0"
},
{
"$ref": "#/components/schemas/TextBlockV0"
}
]
},
"name": {
"description": "The name for this universal content",
"type": "string"
}
},
"required": [
"name",
"definition"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/TemplateUniversalContentEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"UniversalContentPartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/UniversalContentPartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"UniversalContentPartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"definition": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ButtonBlockV0"
},
{
"$ref": "#/components/schemas/DropShadowBlockV0"
},
{
"$ref": "#/components/schemas/HorizontalRuleBlockV0"
},
{
"$ref": "#/components/schemas/HTMLBlockV0"
},
{
"$ref": "#/components/schemas/ImageBlockV0"
},
{
"$ref": "#/components/schemas/SpacerBlockV0"
},
{
"$ref": "#/components/schemas/TextBlockV0"
}
]
},
"name": {
"description": "The name for this template universal content",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The ID of the template universal content",
"example": "01HWWWKAW4RHXQJCMW4R2KRYR4",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/TemplateUniversalContentEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"UniversalContentResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created": {
"description": "The datetime when this universal content was created",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"definition": {
"nullable": true,
"oneOf": [
{
"$ref": "#/components/schemas/ButtonBlockV0"
},
{
"$ref": "#/components/schemas/CouponBlockV0"
},
{
"$ref": "#/components/schemas/DropShadowBlockV0"
},
{
"$ref": "#/components/schemas/HeaderBlockV0"
},
{
"$ref": "#/components/schemas/HorizontalRuleBlockV0"
},
{
"$ref": "#/components/schemas/HTMLBlockV0"
},
{
"$ref": "#/components/schemas/ImageBlockV0"
},
{
"$ref": "#/components/schemas/ProductBlockV0"
},
{
"$ref": "#/components/schemas/ReviewBlockV0"
},
{
"$ref": "#/components/schemas/SocialBlockV0"
},
{
"$ref": "#/components/schemas/SpacerBlockV0"
},
{
"$ref": "#/components/schemas/SplitBlockV0"
},
{
"$ref": "#/components/schemas/TableBlockV0"
},
{
"$ref": "#/components/schemas/TextBlockV0"
},
{
"$ref": "#/components/schemas/UnsupportedBlock"
},
{
"$ref": "#/components/schemas/VideoBlockV0"
},
{
"$ref": "#/components/schemas/SectionV0"
}
]
},
"name": {
"description": "The name for this universal content",
"type": "string"
},
"screenshot_status": {
"description": "The status of a universal content screenshot.",
"enum": [
"completed",
"failed",
"generating",
"never_generated",
"not_renderable",
"stale"
],
"type": "string"
},
"screenshot_url": {
"type": "string"
},
"updated": {
"description": "The datetime when this universal content was updated",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
}
},
"required": [
"name",
"created",
"updated",
"screenshot_status",
"screenshot_url"
],
"type": "object"
},
"id": {
"description": "The ID of the universal content",
"example": "01HWWWKAW4RHXQJCMW4R2KRYR4",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/TemplateUniversalContentEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"UnsubscriptionChannels": {
"properties": {
"email": {
"$ref": "#/components/schemas/EmailUnsubscriptionParameters",
"description": "The subscription parameters to unsubscribe from the \"EMAIL\" Channel.",
"nullable": true
},
"push": {
"$ref": "#/components/schemas/PushUnsubscriptionParameters",
"description": "The subscription parameters to unsubscribe from the \"Push\" Channel.",
"nullable": true
},
"sms": {
"$ref": "#/components/schemas/SMSUnsubscriptionParameters",
"description": "The subscription parameters to unsubscribe from the \"SMS\" Channel.",
"nullable": true
},
"whatsapp": {
"$ref": "#/components/schemas/WhatsAppUnsubscriptionParameters",
"description": "The subscription parameters to unsubscribe from the \"WhatsApp\" Channel.",
"nullable": true
}
},
"type": "object"
},
"UnsubscriptionParameters": {
"properties": {
"consent": {
"description": "The Consent status to be set as part of the unsubscribe call. Currently supports \"UNSUBSCRIBED\".",
"enum": [
"UNSUBSCRIBED"
],
"example": "UNSUBSCRIBED",
"type": "string"
}
},
"required": [
"consent"
],
"type": "object"
},
"UnsupportedBlock": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"type": {
"enum": [
"unsupported"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"UnsupportedSendStrategy": {
"properties": {
"method": {
"enum": [
"unsupported"
],
"type": "string"
}
},
"required": [
"method"
],
"type": "object"
},
"UpdateProfileAction": {
"properties": {
"data": {
"$ref": "#/components/schemas/UpdateProfileActionData",
"description": "The maximum allowed sum of profile strings is 100KB.",
"nullable": true
},
"id": {
"description": "The real ID of an action. Not allowed on create.",
"example": "123",
"nullable": true,
"type": "string"
},
"links": {
"$ref": "#/components/schemas/Link",
"nullable": true
},
"temporary_id": {
"description": "A temporary ID to use only during a create operation. Existing actions should use the id field.",
"example": "action-1",
"nullable": true,
"type": "string",
"writeOnly": true
},
"type": {
"enum": [
"update-profile"
],
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"UpdateProfileActionData": {
"properties": {
"profile_operations": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/ProfileOperationUpdateOrCreateString"
},
{
"$ref": "#/components/schemas/ProfileOperationUpdateOrCreateBoolean"
},
{
"$ref": "#/components/schemas/ProfileOperationUpdateOrCreateNumeric"
},
{
"$ref": "#/components/schemas/ProfileOperationUpdateOrCreateDate"
},
{
"$ref": "#/components/schemas/ProfileOperationUpdateOrCreateList"
},
{
"$ref": "#/components/schemas/ProfileOperationDelete"
}
]
},
"type": "array"
},
"status": {
"default": "draft",
"description": "Flow action status.",
"enum": [
"disabled",
"draft",
"live",
"manual"
],
"example": "draft",
"type": "string"
}
},
"required": [
"profile_operations"
],
"type": "object"
},
"UtmParam": {
"properties": {
"param": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"param",
"value"
],
"type": "object"
},
"ValuesData": {
"properties": {
"groupings": {
"description": "Applied groupings and the values for this object",
"type": "object"
},
"statistics": {
"description": "Requested statistics and their values results",
"type": "object"
}
},
"required": [
"groupings",
"statistics"
],
"type": "object"
},
"VariableTimerConfiguration": {
"properties": {
"days": {
"type": "integer"
},
"hours": {
"type": "integer"
},
"minutes": {
"type": "integer"
},
"type": {
"enum": [
"variable"
],
"type": "string"
}
},
"required": [
"type",
"days",
"hours",
"minutes"
],
"type": "object"
},
"Version": {
"properties": {
"ab_test": {
"default": false,
"type": "boolean"
},
"channel": {
"default": "WEB",
"description": "Form channel type enumeration.",
"enum": [
"IN_APP",
"WEB"
],
"example": "WEB",
"type": "string"
},
"dynamic_button": {
"$ref": "#/components/schemas/DynamicButton",
"nullable": true
},
"id": {
"description": "Not allowed on create.",
"nullable": true,
"type": "integer"
},
"location": {
"description": "Display location enumeration.",
"enum": [
"bottom_center",
"bottom_left",
"bottom_right",
"center_left",
"center_right",
"top_center",
"top_left",
"top_right"
],
"nullable": true,
"type": "string"
},
"message_priority": {
"default": 50,
"example": 50,
"type": "integer"
},
"name": {
"nullable": true,
"type": "string"
},
"properties": {
"$ref": "#/components/schemas/VersionProperties"
},
"specialties": {
"items": {
"description": "Form specialty enumeration.",
"enum": [
"BACK_IN_STOCK"
],
"type": "string"
},
"type": "array"
},
"status": {
"default": "draft",
"description": "Form status enumeration.",
"enum": [
"draft",
"live"
],
"example": "draft",
"type": "string"
},
"steps": {
"items": {
"$ref": "#/components/schemas/Step"
},
"type": "array"
},
"styles": {
"$ref": "#/components/schemas/VersionStyles"
},
"teasers": {
"items": {
"$ref": "#/components/schemas/Teaser"
},
"type": "array"
},
"triggers": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AfterCloseTimeout"
},
{
"$ref": "#/components/schemas/CartContent"
},
{
"$ref": "#/components/schemas/CartItemCount"
},
{
"$ref": "#/components/schemas/CartProduct"
},
{
"$ref": "#/components/schemas/CartValue"
},
{
"$ref": "#/components/schemas/Channel"
},
{
"$ref": "#/components/schemas/CustomJavascript"
},
{
"$ref": "#/components/schemas/Delay"
},
{
"$ref": "#/components/schemas/Device"
},
{
"$ref": "#/components/schemas/ExitIntent"
},
{
"$ref": "#/components/schemas/IdentifiedProfiles"
},
{
"$ref": "#/components/schemas/ListsAndSegments"
},
{
"$ref": "#/components/schemas/Location"
},
{
"$ref": "#/components/schemas/PageVisits"
},
{
"$ref": "#/components/schemas/PreviouslySubmitted"
},
{
"$ref": "#/components/schemas/ProfileEventTracked"
},
{
"$ref": "#/components/schemas/Scroll"
},
{
"$ref": "#/components/schemas/UnidentifiedProfiles"
},
{
"$ref": "#/components/schemas/URLPatterns"
},
{
"$ref": "#/components/schemas/BackInStock"
}
]
},
"type": "array"
},
"type": {
"default": "popup",
"description": "Form type enumeration.",
"enum": [
"banner",
"embed",
"flyout",
"full_screen",
"popup"
],
"example": "popup",
"type": "string"
}
},
"required": [
"steps"
],
"type": "object"
},
"VersionProperties": {
"properties": {
"accessible_name": {
"nullable": true,
"type": "string"
},
"click_outside_to_close": {
"items": {
"description": "Enumeration for mobile and desktop.",
"enum": [
"both",
"desktop",
"mobile"
],
"type": "string"
},
"nullable": true,
"type": "array"
},
"record_utm_params_on_submit": {
"default": false,
"type": "boolean"
},
"rule_based_trigger_evaluation": {
"default": "any",
"description": "Side image alignment enumeration.",
"enum": [
"all",
"any"
],
"example": "any",
"nullable": true,
"type": "string"
},
"show_close_button": {
"default": true,
"example": true,
"type": "boolean"
},
"side_image_settings": {
"$ref": "#/components/schemas/SideImageSettings",
"nullable": true
}
},
"type": "object"
},
"VersionStyles": {
"properties": {
"background_color": {
"default": "#FFFFFF",
"example": "#FFFFFF",
"nullable": true,
"type": "string"
},
"background_image": {
"$ref": "#/components/schemas/BackgroundImage",
"nullable": true
},
"banner_styles": {
"$ref": "#/components/schemas/BannerStyles",
"nullable": true
},
"border_styles": {
"$ref": "#/components/schemas/BorderStyle",
"nullable": true
},
"close_button": {
"$ref": "#/components/schemas/CloseButtonStyle"
},
"custom_css": {
"$ref": "#/components/schemas/CustomCss"
},
"custom_width": {
"nullable": true,
"type": "integer"
},
"drop_shadow": {
"$ref": "#/components/schemas/DropShadow"
},
"input_styles": {
"$ref": "#/components/schemas/InputStyles"
},
"margin": {
"$ref": "#/components/schemas/Margin"
},
"minimum_height": {
"default": 250,
"example": 250,
"type": "integer"
},
"mobile_overlay": {
"$ref": "#/components/schemas/MobileOverlay",
"nullable": true
},
"overlay_color": {
"default": "rgba(20,20,20,0.6)",
"example": "rgba(20,20,20,0.6)",
"type": "string"
},
"padding": {
"$ref": "#/components/schemas/Padding"
},
"rich_text_styles": {
"$ref": "#/components/schemas/RichTextStyles"
},
"width": {
"default": "medium",
"description": "Version width enumeration.",
"enum": [
"custom",
"full",
"large",
"medium",
"small"
],
"example": "medium",
"type": "string"
},
"wrap_content": {
"default": false,
"enum": [
false
],
"type": "boolean"
}
},
"type": "object"
},
"VideoBlockData": {
"properties": {
"display_options": {
"$ref": "#/components/schemas/DisplayOptions"
},
"properties": {
"$ref": "#/components/schemas/VideoBlockProperties"
},
"styles": {
"$ref": "#/components/schemas/VideoBlockStyles"
}
},
"required": [
"properties",
"display_options",
"styles"
],
"type": "object"
},
"VideoBlockProperties": {
"properties": {
"alt_text": {
"nullable": true,
"type": "string"
},
"href": {
"nullable": true,
"type": "string"
},
"overlay_toggle": {
"nullable": true,
"type": "boolean"
},
"raw_asset_id": {
"nullable": true,
"type": "string"
},
"raw_src": {
"nullable": true,
"type": "string"
},
"src": {
"nullable": true,
"type": "string"
},
"src_asset_id": {
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"VideoBlockStyles": {
"properties": {
"align": {
"description": "Image Alignment.",
"enum": [
"center",
"left",
"right"
],
"nullable": true,
"type": "string"
},
"background_color": {
"nullable": true,
"type": "string"
},
"block_background_color": {
"nullable": true,
"type": "string"
},
"block_padding_bottom": {
"nullable": true,
"type": "integer"
},
"block_padding_left": {
"nullable": true,
"type": "integer"
},
"block_padding_right": {
"nullable": true,
"type": "integer"
},
"block_padding_top": {
"nullable": true,
"type": "integer"
},
"border_color": {
"nullable": true,
"type": "string"
},
"border_style": {
"description": "Border style.",
"enum": [
"dashed",
"dotted",
"groove",
"inset",
"none",
"outset",
"ridge",
"solid"
],
"nullable": true,
"type": "string"
},
"border_width": {
"nullable": true,
"type": "integer"
},
"full_width_mobile": {
"nullable": true,
"type": "boolean"
},
"height": {
"nullable": true,
"type": "integer"
},
"inner_padding_bottom": {
"nullable": true,
"type": "integer"
},
"inner_padding_left": {
"nullable": true,
"type": "integer"
},
"inner_padding_right": {
"nullable": true,
"type": "integer"
},
"inner_padding_top": {
"nullable": true,
"type": "integer"
},
"max_width": {
"nullable": true,
"type": "integer"
},
"mobile_stretch_content": {
"nullable": true,
"type": "boolean"
},
"width": {
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"VideoBlockV0": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"nullable": true,
"oneOf": [
{
"type": "integer"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "boolean"
}
]
},
"type": {
"enum": [
"video"
],
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"VideoBlockV1": {
"properties": {
"content_type": {
"enum": [
"block"
],
"type": "string"
},
"data": {
"$ref": "#/components/schemas/VideoBlockData",
"nullable": true
},
"data_id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"id": {
"nullable": true,
"readOnly": true,
"type": "string"
},
"type": {
"enum": [
"video"
],
"type": "string"
},
"universal_id": {
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"required": [
"content_type",
"type",
"data"
],
"type": "object"
},
"Visibility": {
"properties": {
"check": {
"nullable": true,
"type": "string"
},
"definition": {
"nullable": true,
"type": "string"
},
"is_code_only": {
"nullable": true,
"type": "boolean"
}
},
"type": "object"
},
"WebFeedCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/WebFeedCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"WebFeedCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"content_type": {
"description": "The content-type of the web feed",
"enum": [
"json",
"xml"
],
"example": "json",
"type": "string"
},
"name": {
"description": "The name for this web feed",
"example": "Blog_posts",
"type": "string"
},
"request_method": {
"description": "The HTTP method for requesting the web feed",
"enum": [
"get",
"post"
],
"example": "get",
"type": "string"
},
"url": {
"description": "The URL of the web feed",
"example": "https://help.klaviyo.com/api/v2/help_center/en-us/articles.json",
"type": "string"
}
},
"required": [
"name",
"url",
"request_method",
"content_type"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/WebFeedEnum"
}
},
"required": [
"type",
"attributes"
],
"type": "object"
},
"WebFeedEnum": {
"enum": [
"web-feed"
],
"type": "string"
},
"WebFeedPartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/WebFeedPartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"WebFeedPartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"content_type": {
"description": "The content-type of the web feed",
"enum": [
"json",
"xml"
],
"example": "json",
"nullable": true,
"type": "string"
},
"name": {
"description": "The name of this web feed",
"example": "Blog_posts",
"nullable": true,
"type": "string"
},
"request_method": {
"description": "The HTTP method for requesting the web feed",
"enum": [
"get",
"post"
],
"example": "get",
"nullable": true,
"type": "string"
},
"url": {
"description": "The URL of the web feed",
"example": "https://help.klaviyo.com/api/v2/help_center/en-us/articles.json",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The ID of the web feed",
"example": "925e385b52fb",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/WebFeedEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"WebFeedResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"content_type": {
"description": "The content-type of the web feed",
"enum": [
"json",
"xml"
],
"example": "json",
"type": "string"
},
"created": {
"description": "Date and time when the web feed was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"name": {
"description": "The name of this web feed",
"example": "Blog_posts",
"type": "string"
},
"request_method": {
"description": "The HTTP method for requesting the web feed",
"enum": [
"get",
"post"
],
"example": "get",
"type": "string"
},
"status": {
"description": "The cache status of this web feed if it exists",
"enum": [
"critical_nightly_refresh_timeout",
"disabled",
"ok",
"refreshing",
"warning_nightly_refresh_timeout",
"warning_periodic_refresh_timeout"
],
"example": "ok",
"nullable": true,
"type": "string"
},
"updated": {
"description": "Date and time when the web feed was updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T00:00:00+00:00",
"format": "date-time",
"type": "string"
},
"url": {
"description": "The URL of the web feed",
"example": "https://help.klaviyo.com/api/v2/help_center/en-us/articles.json",
"type": "string"
}
},
"required": [
"name",
"url",
"request_method",
"content_type",
"created",
"updated"
],
"type": "object"
},
"id": {
"description": "Primary key that uniquely identifies this web feed. Generated by Klaviyo",
"example": "925e385b52fb",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/WebFeedEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"WebhookCreateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookCreateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"WebhookCreateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"description": {
"description": "A description for the webhook.",
"example": "A webhook for sms events",
"nullable": true,
"type": "string"
},
"endpoint_url": {
"description": "A url to send webhook calls to. Must be https.",
"example": "https://www.example.com/example/path",
"type": "string"
},
"name": {
"description": "A name for the webhook.",
"example": "My Webhook",
"type": "string"
},
"secret_key": {
"description": "A secret key, that will be used for webhook request signing.",
"example": "INSERT_SECRET_KEY",
"type": "string"
}
},
"required": [
"name",
"endpoint_url",
"secret_key"
],
"type": "object"
},
"relationships": {
"properties": {
"webhook-topics": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A list of topics to subscribe to.",
"example": "event:klaviyo.sent_sms",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/WebhookTopicEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"required": [
"webhook-topics"
],
"type": "object"
},
"type": {
"$ref": "#/components/schemas/WebhookEnum"
}
},
"required": [
"type",
"attributes",
"relationships"
],
"type": "object"
},
"WebhookEnum": {
"enum": [
"webhook"
],
"type": "string"
},
"WebhookPartialUpdateQuery": {
"properties": {
"data": {
"$ref": "#/components/schemas/WebhookPartialUpdateQueryResourceObject"
}
},
"required": [
"data"
],
"type": "object"
},
"WebhookPartialUpdateQueryResourceObject": {
"properties": {
"attributes": {
"properties": {
"description": {
"description": "A description for the webhook.",
"nullable": true,
"type": "string"
},
"enabled": {
"description": "Is the webhook enabled.",
"nullable": true,
"type": "boolean"
},
"endpoint_url": {
"description": "A url to send webhook calls to. Must be https.",
"example": "https://www.example.com/example/path",
"nullable": true,
"type": "string"
},
"name": {
"description": "A name for the webhook.",
"nullable": true,
"type": "string"
},
"secret_key": {
"description": "A secret key, that will be used for webhook request signing.",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "The ID of the webhook.",
"type": "string"
},
"relationships": {
"properties": {
"webhook-topics": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A list of topics to subscribe to.",
"example": "event:klaviyo.sent_sms",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/WebhookTopicEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/WebhookEnum"
}
},
"required": [
"type",
"id",
"attributes"
],
"type": "object"
},
"WebhookResponseObjectResource": {
"properties": {
"attributes": {
"properties": {
"created_at": {
"description": "Date and time when the webhook was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T01:23:45+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"description": {
"description": "A description for the webhook.",
"example": "A webhook for sms events",
"nullable": true,
"type": "string"
},
"enabled": {
"description": "Is the webhook enabled.",
"type": "boolean"
},
"endpoint_url": {
"description": "The url to send webhook requests to, truncated for security.",
"example": "https://www.example.com",
"type": "string"
},
"name": {
"description": "A name for the webhook.",
"example": "My Webhook",
"type": "string"
},
"updated_at": {
"description": "Date and time when the webhook was last updated, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)",
"example": "2022-11-08T01:23:45+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"name",
"endpoint_url",
"enabled"
],
"type": "object"
},
"id": {
"description": "The ID of the webhook.",
"example": "01HF7AYTK76RHR4F17G6DGTRGF",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"relationships": {
"properties": {
"webhook-topics": {
"properties": {
"data": {
"items": {
"properties": {
"id": {
"description": "A topic the webhook is subscribed to.",
"example": "event:klaviyo.sent_sms",
"type": "string"
},
"type": {
"$ref": "#/components/schemas/WebhookTopicEnum"
}
},
"required": [
"type",
"id"
],
"type": "object"
},
"type": "array"
},
"links": {
"$ref": "#/components/schemas/RelationshipLinks"
}
},
"type": "object"
}
},
"type": "object"
},
"type": {
"$ref": "#/components/schemas/WebhookEnum"
}
},
"required": [
"type",
"id",
"attributes",
"links"
],
"type": "object"
},
"WebhookTopicEnum": {
"enum": [
"webhook-topic"
],
"type": "string"
},
"WebhookTopicResponseObjectResource": {
"properties": {
"id": {
"description": "The ID of the webhook topic.",
"example": "event:klaviyo.sent_sms",
"type": "string"
},
"links": {
"$ref": "#/components/schemas/ObjectLinks"
},
"type": {
"$ref": "#/components/schemas/WebhookTopicEnum"
}
},
"required": [
"type",
"id",
"links"
],
"type": "object"
},
"WhatsAppSubscriptionParameters": {
"properties": {
"marketing": {
"$ref": "#/components/schemas/SubscriptionParameters",
"description": "The parameters to subscribe to marketing on the \"WhatsApp\" Channel.",
"nullable": true
},
"transactional": {
"$ref": "#/components/schemas/SubscriptionParameters",
"description": "The parameters to subscribe to transactional messaging on the \"WhatsApp\" Channel.",
"nullable": true
}
},
"type": "object"
},
"WhatsAppUnsubscriptionParameters": {
"properties": {
"conversational": {
"$ref": "#/components/schemas/UnsubscriptionParameters",
"description": "The parameters to unsubscribe from conversational messaging on the \"WhatsApp\" channel.",
"nullable": true
},
"marketing": {
"$ref": "#/components/schemas/UnsubscriptionParameters",
"description": "The parameters to unsubscribe from marketing on the \"WhatsApp\" channel.",
"nullable": true
},
"transactional": {
"$ref": "#/components/schemas/UnsubscriptionParameters",
"description": "The parameters to unsubscribe from transactional messaging on the \"WhatsApp\" channel.",
"nullable": true
}
},
"type": "object"
},
"WhatsappChannel": {
"properties": {
"conversational": {
"$ref": "#/components/schemas/WhatsappConversationalChannel",
"description": "The Whatsapp conversational subscription.",
"nullable": true
},
"marketing": {
"$ref": "#/components/schemas/WhatsappMarketingChannel",
"description": "The Whatsapp marketing subscription.",
"nullable": true
},
"transactional": {
"$ref": "#/components/schemas/WhatsappTransactionalChannel",
"description": "The Whatsapp transactional subscription.",
"nullable": true
}
},
"type": "object"
},
"WhatsappConversationalChannel": {
"properties": {
"can_receive": {
"description": "Whether the profile can receive messages on this channel.",
"type": "boolean"
},
"consent": {
"description": "The consent status for the channel.",
"example": "SUBSCRIBED",
"type": "string"
},
"consent_timestamp": {
"description": "The timestamp when consent was recorded or updated for the channel, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"created_timestamp": {
"description": "The timestamp when the channel was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_updated": {
"description": "The timestamp when the channel was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"metadata": {
"description": "Channel-specific metadata containing additional information about the permission.",
"nullable": true,
"type": "object"
},
"phone_number": {
"description": "Phone number to which the consent was granted for.",
"nullable": true,
"type": "string"
},
"valid_until": {
"description": "Optional expiration date for the permission, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2024-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"consent",
"can_receive"
],
"type": "object"
},
"WhatsappMarketingChannel": {
"properties": {
"can_receive": {
"description": "Whether the profile can receive messages on this channel.",
"type": "boolean"
},
"consent": {
"description": "The consent status for the channel.",
"example": "SUBSCRIBED",
"type": "string"
},
"consent_timestamp": {
"description": "The timestamp when consent was recorded or updated for the channel, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"created_timestamp": {
"description": "The timestamp when the channel was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_updated": {
"description": "The timestamp when the channel was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"metadata": {
"description": "Channel-specific metadata containing additional information about the permission.",
"nullable": true,
"type": "object"
},
"phone_number": {
"description": "Phone number to which the consent was granted for.",
"nullable": true,
"type": "string"
},
"valid_until": {
"description": "Optional expiration date for the permission, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2024-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"consent",
"can_receive"
],
"type": "object"
},
"WhatsappTransactionalChannel": {
"properties": {
"can_receive": {
"description": "Whether the profile can receive messages on this channel.",
"type": "boolean"
},
"consent": {
"description": "The consent status for the channel.",
"example": "SUBSCRIBED",
"type": "string"
},
"consent_timestamp": {
"description": "The timestamp when consent was recorded or updated for the channel, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"created_timestamp": {
"description": "The timestamp when the channel was created, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"last_updated": {
"description": "The timestamp when the channel was last modified, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2023-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
},
"metadata": {
"description": "Channel-specific metadata containing additional information about the permission.",
"nullable": true,
"type": "object"
},
"phone_number": {
"description": "Phone number to which the consent was granted for.",
"nullable": true,
"type": "string"
},
"valid_until": {
"description": "Optional expiration date for the permission, in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm).",
"example": "2024-02-21T20:07:38+00:00",
"format": "date-time",
"nullable": true,
"type": "string"
}
},
"required": [
"consent",
"can_receive"
],
"type": "object"
}
},
"securitySchemes": {
"Klaviyo-API-Key": {
"description": "Private key authentication for /api/ endpoints is performed by setting the `Authorization` header to `Klaviyo-API-Key your-private-api-key`
For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#authentication",
"in": "header",
"name": "Authorization",
"type": "apiKey",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"info": {
"contact": {
"email": "developers@klaviyo.com",
"name": "Klaviyo Developer Experience Team",
"url": "https://developers.klaviyo.com"
},
"description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.",
"license": {
"name": "License",
"url": "https://www.klaviyo.com/legal"
},
"termsOfService": "https://www.klaviyo.com/legal/api-terms",
"title": "Klaviyo API",
"version": "2026-04-15"
},
"openapi": "3.0.2",
"paths": {
"/api/accounts": {
"get": {
"description": "Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.\n\nYou can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`accounts:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_accounts.json)",
"operationId": "get_accounts",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[account]",
"required": false,
"schema": {
"items": {
"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",
"id",
"industry",
"locale",
"preferred_currency",
"public_api_key",
"test_account",
"timezone"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetAccountResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Accounts",
"tags": [
"Accounts"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"accounts:read"
]
}
},
"/api/accounts/{id}": {
"get": {
"description": "Retrieve a single account object by its account ID. You can only request the account by which the private API key was generated.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`accounts:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_account.json)",
"operationId": "get_account",
"parameters": [
{
"description": "The ID of the account",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the account",
"example": "AbC123",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[account]",
"required": false,
"schema": {
"items": {
"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",
"id",
"industry",
"locale",
"preferred_currency",
"public_api_key",
"test_account",
"timezone"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetAccountResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Account",
"tags": [
"Accounts"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"accounts:read"
]
}
},
"/api/back-in-stock-subscriptions": {
"post": {
"description": "Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details.\n\nThis endpoint is specifically designed to be called from server-side applications. To create subscriptions from client-side contexts, use [POST /client/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_client_back_in_stock_subscription).
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_back_in_stock_subscription.json)",
"operationId": "create_back_in_stock_subscription",
"parameters": [
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ServerBISSubscriptionCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Back In Stock Subscription",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:write",
"profiles:write"
],
"x-klaviyo-subtag": "Back In Stock"
}
},
"/api/campaign-clone": {
"post": {
"description": "Clones an existing campaign, returning a new campaign based on the original with a new ID and name.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_campaign_clone.json)",
"operationId": "create_campaign_clone",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"id",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CampaignCloneQuery"
}
}
},
"description": "Clones a campaign from an existing campaign",
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCampaignResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Campaign Clone",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"clone_campaign"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:write"
]
}
},
"/api/campaign-message-assign-template": {
"post": {
"description": "Creates a non-reusable version of the template and assigns it to the message.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/assign_template_to_campaign_message.json)",
"operationId": "assign_template_to_campaign_message",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-message]",
"required": false,
"schema": {
"items": {
"enum": [
"channel",
"content",
"content.bcc_email",
"content.body",
"content.cc_email",
"content.from_email",
"content.from_label",
"content.media_url",
"content.preview_text",
"content.reply_to_email",
"content.subject",
"created_at",
"id",
"label",
"render_options",
"render_options.add_info_link",
"render_options.add_opt_out_language",
"render_options.add_org_prefix",
"render_options.shorten_links",
"send_times",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CampaignMessageAssignTemplateQuery"
}
}
},
"description": "Takes a reusable template, clones it, and assigns the non-reusable clone to the message.",
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCampaignMessageResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Assign Template to Campaign Message",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"create_campaign_message_assign_template"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:write"
],
"x-klaviyo-subtag": "Messages"
}
},
"/api/campaign-messages/{id}": {
"get": {
"description": "Returns a specific message based on a required id.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_message.json)",
"operationId": "get_campaign_message",
"parameters": [
{
"description": "The message ID to be retrieved",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The message ID to be retrieved",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-message]",
"required": false,
"schema": {
"items": {
"enum": [
"created_at",
"definition",
"definition.channel",
"definition.content",
"definition.content.action_buttons",
"definition.content.bcc_email",
"definition.content.body",
"definition.content.cc_email",
"definition.content.dynamic_image",
"definition.content.from_email",
"definition.content.from_label",
"definition.content.media_url",
"definition.content.preview_text",
"definition.content.reply_to_email",
"definition.content.subject",
"definition.content.title",
"definition.kv_pairs",
"definition.label",
"definition.notification_type",
"definition.options",
"definition.options.badge",
"definition.options.badge.badge_options",
"definition.options.badge.badge_options.badge_config",
"definition.options.badge.badge_options.set_from_property",
"definition.options.badge.badge_options.value",
"definition.options.badge.display",
"definition.options.on_open",
"definition.options.on_open.android_deep_link",
"definition.options.on_open.ios_deep_link",
"definition.options.on_open.type",
"definition.options.on_open.web_url",
"definition.options.play_sound",
"definition.render_options",
"definition.render_options.add_info_link",
"definition.render_options.add_opt_out_language",
"definition.render_options.add_org_prefix",
"definition.render_options.shorten_links",
"id",
"send_times",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"id",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[image]",
"required": false,
"schema": {
"items": {
"enum": [
"format",
"hidden",
"id",
"image_url",
"name",
"size",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"campaign",
"image",
"template"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignMessageResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Campaign Message",
"tags": [
"Campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
],
"x-klaviyo-subtag": "Messages"
},
"patch": {
"description": "Update a campaign message
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign_message.json)",
"operationId": "update_campaign_message",
"parameters": [
{
"description": "The message ID to be retrieved",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The message ID to be retrieved",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-message]",
"required": false,
"schema": {
"items": {
"enum": [
"created_at",
"definition",
"definition.channel",
"definition.content",
"definition.content.action_buttons",
"definition.content.bcc_email",
"definition.content.body",
"definition.content.cc_email",
"definition.content.dynamic_image",
"definition.content.from_email",
"definition.content.from_label",
"definition.content.media_url",
"definition.content.preview_text",
"definition.content.reply_to_email",
"definition.content.subject",
"definition.content.title",
"definition.kv_pairs",
"definition.label",
"definition.notification_type",
"definition.options",
"definition.options.badge",
"definition.options.badge.badge_options",
"definition.options.badge.badge_options.badge_config",
"definition.options.badge.badge_options.set_from_property",
"definition.options.badge.badge_options.value",
"definition.options.badge.display",
"definition.options.on_open",
"definition.options.on_open.android_deep_link",
"definition.options.on_open.ios_deep_link",
"definition.options.on_open.type",
"definition.options.on_open.web_url",
"definition.options.play_sound",
"definition.render_options",
"definition.render_options.add_info_link",
"definition.render_options.add_opt_out_language",
"definition.render_options.add_org_prefix",
"definition.render_options.shorten_links",
"id",
"send_times",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CampaignMessagePartialUpdateQuery"
}
}
},
"description": "Update a message and return it",
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchCampaignMessageResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Campaign Message",
"tags": [
"Campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:write"
],
"x-klaviyo-subtag": "Messages"
}
},
"/api/campaign-messages/{id}/campaign": {
"get": {
"description": "Return the related campaign
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_for_campaign_message.json)",
"operationId": "get_campaign_for_campaign_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"id",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Campaign for Campaign Message",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"get_campaign_message_campaign"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
],
"x-klaviyo-subtag": "Messages"
}
},
"/api/campaign-messages/{id}/image": {
"get": {
"description": "Return the related image for a given campaign message
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image_for_campaign_message.json)",
"operationId": "get_image_for_campaign_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[image]",
"required": false,
"schema": {
"items": {
"enum": [
"format",
"hidden",
"id",
"image_url",
"name",
"size",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetImageResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Image for Campaign Message",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"get_campaign_message_image"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read",
"images:read"
],
"x-klaviyo-subtag": "Messages"
}
},
"/api/campaign-messages/{id}/relationships/campaign": {
"get": {
"description": "Returns the ID of the related campaign
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_id_for_campaign_message.json)",
"operationId": "get_campaign_id_for_campaign_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignMessageCampaignRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Campaign ID for Campaign Message",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"get_campaign_message_relationships_campaign"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
],
"x-klaviyo-subtag": "Messages"
}
},
"/api/campaign-messages/{id}/relationships/image": {
"get": {
"description": "Returns the ID of the related image
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image_id_for_campaign_message.json)",
"operationId": "get_image_id_for_campaign_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignMessageImageRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Image ID for Campaign Message",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"get_campaign_message_relationships_image"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read",
"images:read"
],
"x-klaviyo-subtag": "Messages"
},
"patch": {
"description": "Update a campaign message image
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_image_for_campaign_message.json)",
"operationId": "update_image_for_campaign_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CampaignMessageImageUpdateQuery"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Image for Campaign Message",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"update_campaign_message_relationships_image"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:write",
"images:read"
],
"x-klaviyo-subtag": "Messages"
}
},
"/api/campaign-messages/{id}/relationships/template": {
"get": {
"description": "Returns the ID of the related template
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_campaign_message.json)",
"operationId": "get_template_id_for_campaign_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignMessageTemplateRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Template ID for Campaign Message",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"get_campaign_message_relationships_template"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read",
"templates:read"
],
"x-klaviyo-subtag": "Messages"
}
},
"/api/campaign-messages/{id}/template": {
"get": {
"description": "Return the related template
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_campaign_message.json)",
"operationId": "get_template_for_campaign_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTemplateResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Template for Campaign Message",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"get_campaign_message_template"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read",
"templates:read"
],
"x-klaviyo-subtag": "Messages"
}
},
"/api/campaign-recipient-estimation-jobs": {
"post": {
"description": "Trigger an asynchronous job to update the estimated number of recipients\nfor the given campaign ID. Use the `Get Campaign Recipient Estimation\nJob` endpoint to retrieve the status of this estimation job. Use the\n`Get Campaign Recipient Estimation` endpoint to retrieve the estimated\nrecipient count for a given campaign.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/refresh_campaign_recipient_estimation.json)",
"operationId": "refresh_campaign_recipient_estimation",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-recipient-estimation-job]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"status"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CampaignRecipientEstimationJobCreateQuery"
}
}
},
"description": "Trigger an asynchronous job to update the estimated number of recipients\nfor the given campaign ID. Use the `Get Campaign Recipient Estimation\nJob` endpoint to retrieve the status of this estimation job. Use the\n`Get Campaign Recipient Estimation` endpoint to retrieve the estimated\nrecipient count for a given campaign.",
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCampaignRecipientEstimationJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Refresh Campaign Recipient Estimation",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"create_campaign_recipient_estimation_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:write"
],
"x-klaviyo-subtag": "Jobs"
}
},
"/api/campaign-recipient-estimation-jobs/{id}": {
"get": {
"description": "Retrieve the status of a recipient estimation job triggered\nwith the `Create Campaign Recipient Estimation Job` endpoint.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_recipient_estimation_job.json)",
"operationId": "get_campaign_recipient_estimation_job",
"parameters": [
{
"description": "The ID of the campaign to get recipient estimation status",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the campaign to get recipient estimation status",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-recipient-estimation-job]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"status"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignRecipientEstimationJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Campaign Recipient Estimation Job",
"tags": [
"Campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
],
"x-klaviyo-subtag": "Jobs"
}
},
"/api/campaign-recipient-estimations/{id}": {
"get": {
"description": "Get the estimated recipient count for a campaign with the provided campaign ID.\nYou can refresh this count by using the `Create Campaign Recipient Estimation Job` endpoint.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_recipient_estimation.json)",
"operationId": "get_campaign_recipient_estimation",
"parameters": [
{
"description": "The ID of the campaign for which to get the estimated number of recipients",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the campaign for which to get the estimated number of recipients",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-recipient-estimation]",
"required": false,
"schema": {
"items": {
"enum": [
"estimated_recipient_count",
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignRecipientEstimationResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Campaign Recipient Estimation",
"tags": [
"Campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
]
}
},
"/api/campaign-send-jobs": {
"post": {
"description": "Trigger a campaign to send asynchronously
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/send_campaign.json)",
"operationId": "send_campaign",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-send-job]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"status"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CampaignSendJobCreateQuery"
}
}
},
"description": "Trigger the campaign to send asynchronously",
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCampaignSendJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Send Campaign",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"create_campaign_send_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:write"
],
"x-klaviyo-subtag": "Jobs"
}
},
"/api/campaign-send-jobs/{id}": {
"get": {
"description": "Get a campaign send job
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_send_job.json)",
"operationId": "get_campaign_send_job",
"parameters": [
{
"description": "The ID of the campaign to send",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the campaign to send",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-send-job]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"status"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignSendJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Campaign Send Job",
"tags": [
"Campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
],
"x-klaviyo-subtag": "Jobs"
},
"patch": {
"description": "Permanently cancel the campaign, setting the status to CANCELED or\nrevert the campaign, setting the status back to DRAFT
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/cancel_campaign_send.json)",
"operationId": "cancel_campaign_send",
"parameters": [
{
"description": "The ID of the currently sending campaign to cancel or revert",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the currently sending campaign to cancel or revert",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CampaignSendJobPartialUpdateQuery"
}
}
},
"description": "Permanently cancel the campaign, setting the status to CANCELED or\nrevert the campaign, setting the status back to DRAFT",
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Cancel Campaign Send",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"update_campaign_send_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:write"
],
"x-klaviyo-subtag": "Jobs"
}
},
"/api/campaign-values-reports": {
"post": {
"description": "Returns the requested campaign analytics values data
*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_campaign_values.json)",
"operationId": "query_campaign_values",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-values-report]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"results"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page_cursor",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CampaignValuesRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCampaignValuesResponseDTO"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Query Campaign Values",
"tags": [
"Reporting"
],
"x-klaviyo-operation-aliases": [
"create_campaign_value_report",
"create_campaign_values_report"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "225/d",
"steady": "2/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
]
}
},
"/api/campaigns": {
"get": {
"description": "Returns some or all campaigns based on filters.\n\nA channel filter is required to list campaigns. Please provide either:\n`?filter=equals(messages.channel,'email')` to list email campaigns, or\n`?filter=equals(messages.channel,'sms')` to list SMS campaigns.\n`?filter=equals(messages.channel,'mobile_push')` to list mobile push campaigns.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaigns.json)",
"operationId": "get_campaigns",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-message]",
"required": false,
"schema": {
"items": {
"enum": [
"created_at",
"definition",
"definition.channel",
"definition.content",
"definition.content.action_buttons",
"definition.content.bcc_email",
"definition.content.body",
"definition.content.cc_email",
"definition.content.dynamic_image",
"definition.content.from_email",
"definition.content.from_label",
"definition.content.media_url",
"definition.content.preview_text",
"definition.content.reply_to_email",
"definition.content.subject",
"definition.content.title",
"definition.kv_pairs",
"definition.label",
"definition.notification_type",
"definition.options",
"definition.options.badge",
"definition.options.badge.badge_options",
"definition.options.badge.badge_options.badge_config",
"definition.options.badge.badge_options.set_from_property",
"definition.options.badge.badge_options.value",
"definition.options.badge.display",
"definition.options.on_open",
"definition.options.on_open.android_deep_link",
"definition.options.on_open.ios_deep_link",
"definition.options.on_open.type",
"definition.options.on_open.web_url",
"definition.options.play_sound",
"definition.render_options",
"definition.render_options.add_info_link",
"definition.render_options.add_opt_out_language",
"definition.render_options.add_org_prefix",
"definition.render_options.shorten_links",
"id",
"send_times",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"id",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`messages.channel`: `equals`
`name`: `contains`
`status`: `any`, `equals`
`archived`: `equals`
`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`scheduled_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"required": true,
"schema": {
"example": "equals(messages.channel,'email')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"campaign-messages",
"tags"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created_at",
"-created_at",
"id",
"-id",
"name",
"-name",
"scheduled_at",
"-scheduled_at",
"updated_at",
"-updated_at"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Campaigns",
"tags": [
"Campaigns"
],
"x-klaviyo-filters": {
"archived": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"created_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"messages.channel": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"email",
"sms",
"mobile_push"
],
"type": "string"
}
},
"name": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
},
"scheduled_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"status": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"enum": [
"Scheduled",
"Sent",
"Draft",
"Cancelled",
"Adding Recipients",
"Sending",
"Variations Sent",
"Sending Segments",
"Cancelled: Smart Sending",
"Preparing to send",
"Cancelled: Account Disabled",
"Cancelled: No Recipients",
"Preparing to schedule",
"Cancelled: Internal Error",
"Queued without Recipients",
"Cancelled: Billing Limit",
"Cancelled: Misconfigured",
"Unknown"
],
"type": "string"
}
},
"updated_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
]
},
"post": {
"description": "Creates a campaign given a set of parameters, then returns it.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_campaign.json)",
"operationId": "create_campaign",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"id",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CampaignCreateQuery"
}
}
},
"description": "Creates a campaign from parameters",
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCampaignResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Campaign",
"tags": [
"Campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:write"
]
}
},
"/api/campaigns/{id}": {
"delete": {
"description": "Delete a campaign with the given campaign ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_campaign.json)",
"operationId": "delete_campaign",
"parameters": [
{
"description": "The campaign ID to be deleted",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The campaign ID to be deleted",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Campaign",
"tags": [
"Campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:write"
]
},
"get": {
"description": "Returns a specific campaign based on a required id.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign.json)",
"operationId": "get_campaign",
"parameters": [
{
"description": "The campaign ID to be retrieved",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The campaign ID to be retrieved",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-message]",
"required": false,
"schema": {
"items": {
"enum": [
"created_at",
"definition",
"definition.channel",
"definition.content",
"definition.content.action_buttons",
"definition.content.bcc_email",
"definition.content.body",
"definition.content.cc_email",
"definition.content.dynamic_image",
"definition.content.from_email",
"definition.content.from_label",
"definition.content.media_url",
"definition.content.preview_text",
"definition.content.reply_to_email",
"definition.content.subject",
"definition.content.title",
"definition.kv_pairs",
"definition.label",
"definition.notification_type",
"definition.options",
"definition.options.badge",
"definition.options.badge.badge_options",
"definition.options.badge.badge_options.badge_config",
"definition.options.badge.badge_options.set_from_property",
"definition.options.badge.badge_options.value",
"definition.options.badge.display",
"definition.options.on_open",
"definition.options.on_open.android_deep_link",
"definition.options.on_open.ios_deep_link",
"definition.options.on_open.type",
"definition.options.on_open.web_url",
"definition.options.play_sound",
"definition.render_options",
"definition.render_options.add_info_link",
"definition.render_options.add_opt_out_language",
"definition.render_options.add_org_prefix",
"definition.render_options.shorten_links",
"id",
"send_times",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"id",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"campaign-messages",
"tags"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Campaign",
"tags": [
"Campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
]
},
"patch": {
"description": "Update a campaign with the given campaign ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_campaign.json)",
"operationId": "update_campaign",
"parameters": [
{
"description": "The campaign ID to be retrieved",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The campaign ID to be retrieved",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"id",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CampaignPartialUpdateQuery"
}
}
},
"description": "Update a campaign and return it",
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchCampaignResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Campaign",
"tags": [
"Campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:write"
]
}
},
"/api/campaigns/{id}/campaign-messages": {
"get": {
"description": "Return all messages that belong to the given campaign.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_messages_for_campaign.json)",
"operationId": "get_messages_for_campaign",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign-message]",
"required": false,
"schema": {
"items": {
"enum": [
"created_at",
"definition",
"definition.channel",
"definition.content",
"definition.content.action_buttons",
"definition.content.bcc_email",
"definition.content.body",
"definition.content.cc_email",
"definition.content.dynamic_image",
"definition.content.from_email",
"definition.content.from_label",
"definition.content.media_url",
"definition.content.preview_text",
"definition.content.reply_to_email",
"definition.content.subject",
"definition.content.title",
"definition.kv_pairs",
"definition.label",
"definition.notification_type",
"definition.options",
"definition.options.badge",
"definition.options.badge.badge_options",
"definition.options.badge.badge_options.badge_config",
"definition.options.badge.badge_options.set_from_property",
"definition.options.badge.badge_options.value",
"definition.options.badge.display",
"definition.options.on_open",
"definition.options.on_open.android_deep_link",
"definition.options.on_open.ios_deep_link",
"definition.options.on_open.type",
"definition.options.on_open.web_url",
"definition.options.play_sound",
"definition.render_options",
"definition.render_options.add_info_link",
"definition.render_options.add_opt_out_language",
"definition.render_options.add_org_prefix",
"definition.render_options.shorten_links",
"id",
"send_times",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[campaign]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"audiences",
"audiences.excluded",
"audiences.included",
"created_at",
"id",
"name",
"scheduled_at",
"send_options",
"send_options.use_smart_sending",
"send_strategy",
"send_strategy.date",
"send_strategy.datetime",
"send_strategy.method",
"send_strategy.options",
"send_strategy.options.is_local",
"send_strategy.options.send_past_recipients_immediately",
"send_strategy.throttle_percentage",
"send_time",
"status",
"tracking_options",
"tracking_options.add_tracking_params",
"tracking_options.custom_tracking_params",
"tracking_options.is_tracking_clicks",
"tracking_options.is_tracking_opens",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[image]",
"required": false,
"schema": {
"items": {
"enum": [
"format",
"hidden",
"id",
"image_url",
"name",
"size",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"campaign",
"image",
"template"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignMessageResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Messages for Campaign",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"get_campaign_campaign_messages",
"get_campaign_messages"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
]
}
},
"/api/campaigns/{id}/relationships/campaign-messages": {
"get": {
"description": "Returns the IDs of all messages associated with the given campaign.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_campaign.json)",
"operationId": "get_message_ids_for_campaign",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignMessagesRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Message IDs for Campaign",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"get_campaign_relationships_campaign_messages",
"get_campaign_relationships_messages"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"campaigns:read"
]
}
},
"/api/campaigns/{id}/relationships/tags": {
"get": {
"description": "Returns the IDs of all tags associated with the given campaign.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`campaigns:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_campaign.json)",
"operationId": "get_tag_ids_for_campaign",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCampaignTagsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tag IDs for Campaign",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"get_campaign_relationships_tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"campaigns:read",
"tags:read"
]
}
},
"/api/campaigns/{id}/tags": {
"get": {
"description": "Return all tags that belong to the given campaign.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`campaigns:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_campaign.json)",
"operationId": "get_tags_for_campaign",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tags for Campaign",
"tags": [
"Campaigns"
],
"x-klaviyo-operation-aliases": [
"get_campaign_tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"campaigns:read",
"tags:read"
]
}
},
"/api/catalog-categories": {
"get": {
"description": "Get all catalog categories in an account.\n\nCatalog categories can be sorted by the following fields, in ascending and descending order:\n`created`\n\nCurrently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.\n\nReturns a maximum of 100 categories per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_categories.json)",
"operationId": "get_catalog_categories",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category]",
"required": false,
"schema": {
"items": {
"enum": [
"external_id",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`ids`: `any`
`item.id`: `equals`
`name`: `contains`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(ids,['$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogCategoryResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Catalog Categories",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"ids": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"item.id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Categories"
},
"post": {
"description": "Create a new catalog category.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_category.json)",
"operationId": "create_catalog_category",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category]",
"required": false,
"schema": {
"items": {
"enum": [
"external_id",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogCategoryCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogCategoryResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Catalog Category",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Categories"
}
},
"/api/catalog-categories/{id}": {
"delete": {
"description": "Delete a catalog category using the given category ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_category.json)",
"operationId": "delete_catalog_category",
"parameters": [
{
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Catalog Category",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Categories"
},
"get": {
"description": "Get a catalog category with the given category ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_category.json)",
"operationId": "get_catalog_category",
"parameters": [
{
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category]",
"required": false,
"schema": {
"items": {
"enum": [
"external_id",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogCategoryResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Catalog Category",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Categories"
},
"patch": {
"description": "Update a catalog category with the given category ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_category.json)",
"operationId": "update_catalog_category",
"parameters": [
{
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category]",
"required": false,
"schema": {
"items": {
"enum": [
"external_id",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogCategoryUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchCatalogCategoryResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Catalog Category",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Categories"
}
},
"/api/catalog-categories/{id}/items": {
"get": {
"description": "Get all items in a category with the given category ID.\n\nItems can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 items per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_items_for_catalog_category.json)",
"operationId": "get_items_for_catalog_category",
"parameters": [
{
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"nullable": true,
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"price",
"published",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"inventory_policy",
"inventory_quantity",
"price",
"published",
"sku",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`ids`: `any`
`category.id`: `equals`
`title`: `contains`
`published`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"variants"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Items for Catalog Category",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"category.id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"ids": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"published": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"title": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_catalog_category_items"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Items"
}
},
"/api/catalog-categories/{id}/relationships/items": {
"delete": {
"description": "Delete item relationships for the given category ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_items_from_catalog_category.json)",
"operationId": "remove_items_from_catalog_category",
"parameters": [
{
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogCategoryItemOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Remove Items from Catalog Category",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"delete_catalog_category_relationships_items"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Categories"
},
"get": {
"description": "Get all items in the given category ID. Returns a maximum of 100 items per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_item_ids_for_catalog_category.json)",
"operationId": "get_item_ids_for_catalog_category",
"parameters": [
{
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"nullable": true,
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`ids`: `any`
`category.id`: `equals`
`title`: `contains`
`published`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogCategoryItemsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Item IDs for Catalog Category",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"category.id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"ids": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"published": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"title": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_catalog_category_relationships_items"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Categories"
},
"patch": {
"description": "Update item relationships for the given category ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_items_for_catalog_category.json)",
"operationId": "update_items_for_catalog_category",
"parameters": [
{
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogCategoryItemOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Items for Catalog Category",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"update_catalog_category_relationships_items"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Categories"
},
"post": {
"description": "Create a new item relationship for the given category ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_items_to_catalog_category.json)",
"operationId": "add_items_to_catalog_category",
"parameters": [
{
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogCategoryItemOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Add Items to Catalog Category",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"create_catalog_category_relationships_item",
"create_catalog_category_relationships_items"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Categories"
}
},
"/api/catalog-category-bulk-create-jobs": {
"get": {
"description": "Get all catalog category bulk create jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_jobs.json)",
"operationId": "get_bulk_create_categories_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogCategoryCreateJobResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Create Categories Jobs",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_create_categories_jobs",
"get_catalog_category_bulk_create_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Categories"
},
"post": {
"description": "Create a catalog category bulk create job to create a batch of catalog categories.\n\nAccepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_categories.json)",
"operationId": "bulk_create_catalog_categories",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogCategoryCreateJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogCategoryCreateJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Create Catalog Categories",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"spawn_create_categories_job",
"create_catalog_category_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Categories"
}
},
"/api/catalog-category-bulk-create-jobs/{job_id}": {
"get": {
"description": "Get a catalog category bulk create job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `categories`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_categories_job.json)",
"operationId": "get_bulk_create_categories_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category]",
"required": false,
"schema": {
"items": {
"enum": [
"external_id",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"categories"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogCategoryCreateJobResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Create Categories Job",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"get_create_categories_job",
"get_catalog_category_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Categories"
}
},
"/api/catalog-category-bulk-delete-jobs": {
"get": {
"description": "Get all catalog category bulk delete jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_jobs.json)",
"operationId": "get_bulk_delete_categories_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogCategoryDeleteJobResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Delete Categories Jobs",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_delete_categories_jobs",
"get_catalog_category_bulk_delete_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Categories"
},
"post": {
"description": "Create a catalog category bulk delete job to delete a batch of catalog categories.\n\nAccepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_categories.json)",
"operationId": "bulk_delete_catalog_categories",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogCategoryDeleteJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogCategoryDeleteJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Delete Catalog Categories",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"spawn_delete_categories_job",
"create_catalog_category_bulk_delete_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Categories"
}
},
"/api/catalog-category-bulk-delete-jobs/{job_id}": {
"get": {
"description": "Get a catalog category bulk delete job with the given job ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_categories_job.json)",
"operationId": "get_bulk_delete_categories_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogCategoryDeleteJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Delete Categories Job",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"get_delete_categories_job",
"get_catalog_category_bulk_delete_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Categories"
}
},
"/api/catalog-category-bulk-update-jobs": {
"get": {
"description": "Get all catalog category bulk update jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_jobs.json)",
"operationId": "get_bulk_update_categories_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category-bulk-update-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogCategoryUpdateJobResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Update Categories Jobs",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_update_categories_jobs",
"get_catalog_category_bulk_update_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Categories"
},
"post": {
"description": "Create a catalog category bulk update job to update a batch of catalog categories.\n\nAccepts up to 100 catalog categories per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_categories.json)",
"operationId": "bulk_update_catalog_categories",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category-bulk-update-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogCategoryUpdateJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogCategoryUpdateJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Update Catalog Categories",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"spawn_update_categories_job",
"create_catalog_category_bulk_update_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Categories"
}
},
"/api/catalog-category-bulk-update-jobs/{job_id}": {
"get": {
"description": "Get a catalog category bulk update job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `categories`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_categories_job.json)",
"operationId": "get_bulk_update_categories_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category-bulk-update-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category]",
"required": false,
"schema": {
"items": {
"enum": [
"external_id",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"categories"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogCategoryUpdateJobResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Update Categories Job",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"get_update_categories_job",
"get_catalog_category_bulk_update_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Categories"
}
},
"/api/catalog-item-bulk-create-jobs": {
"get": {
"description": "Get all catalog item bulk create jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_jobs.json)",
"operationId": "get_bulk_create_catalog_items_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemCreateJobResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Create Catalog Items Jobs",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_create_items_jobs",
"get_catalog_item_bulk_create_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Items"
},
"post": {
"description": "Create a catalog item bulk create job to create a batch of catalog items.\n\nAccepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_items.json)",
"operationId": "bulk_create_catalog_items",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogItemCreateJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogItemCreateJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Create Catalog Items",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"spawn_create_items_job",
"create_catalog_item_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Items"
}
},
"/api/catalog-item-bulk-create-jobs/{job_id}": {
"get": {
"description": "Get a catalog item bulk create job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `items`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_catalog_items_job.json)",
"operationId": "get_bulk_create_catalog_items_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"price",
"published",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"items"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemCreateJobResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Create Catalog Items Job",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"get_create_items_job",
"get_catalog_item_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Items"
}
},
"/api/catalog-item-bulk-delete-jobs": {
"get": {
"description": "Get all catalog item bulk delete jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_jobs.json)",
"operationId": "get_bulk_delete_catalog_items_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemDeleteJobResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Delete Catalog Items Jobs",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_delete_items_jobs",
"get_catalog_item_bulk_delete_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Items"
},
"post": {
"description": "Create a catalog item bulk delete job to delete a batch of catalog items.\n\nAccepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_items.json)",
"operationId": "bulk_delete_catalog_items",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogItemDeleteJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogItemDeleteJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Delete Catalog Items",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"spawn_delete_items_job",
"create_catalog_item_bulk_delete_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Items"
}
},
"/api/catalog-item-bulk-delete-jobs/{job_id}": {
"get": {
"description": "Get a catalog item bulk delete job with the given job ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_catalog_items_job.json)",
"operationId": "get_bulk_delete_catalog_items_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemDeleteJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Delete Catalog Items Job",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"get_delete_items_job",
"get_catalog_item_bulk_delete_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Items"
}
},
"/api/catalog-item-bulk-update-jobs": {
"get": {
"description": "Get all catalog item bulk update jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_jobs.json)",
"operationId": "get_bulk_update_catalog_items_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item-bulk-update-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemUpdateJobResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Update Catalog Items Jobs",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_update_items_jobs",
"get_catalog_item_bulk_update_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Items"
},
"post": {
"description": "Create a catalog item bulk update job to update a batch of catalog items.\n\nAccepts up to 100 catalog items per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_items.json)",
"operationId": "bulk_update_catalog_items",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item-bulk-update-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogItemUpdateJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogItemUpdateJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Update Catalog Items",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"spawn_update_items_job",
"create_catalog_item_bulk_update_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Items"
}
},
"/api/catalog-item-bulk-update-jobs/{job_id}": {
"get": {
"description": "Get a catalog item bulk update job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `items`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_catalog_items_job.json)",
"operationId": "get_bulk_update_catalog_items_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item-bulk-update-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"price",
"published",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"items"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemUpdateJobResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Update Catalog Items Job",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"get_update_items_job",
"get_catalog_item_bulk_update_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Items"
}
},
"/api/catalog-items": {
"get": {
"description": "Get all catalog items in an account.\n\nCatalog items can be sorted by the following fields, in ascending and descending order:\n`created`\n\nCurrently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.\n\nReturns a maximum of 100 items per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_items.json)",
"operationId": "get_catalog_items",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"price",
"published",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"inventory_policy",
"inventory_quantity",
"price",
"published",
"sku",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`ids`: `any`
`category.id`: `equals`
`title`: `contains`
`published`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"variants"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Catalog Items",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"category.id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"ids": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"published": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"title": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Items"
},
"post": {
"description": "Create a new catalog item.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_item.json)",
"operationId": "create_catalog_item",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"price",
"published",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogItemCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogItemResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Items"
}
},
"/api/catalog-items/{id}": {
"delete": {
"description": "Delete a catalog item with the given item ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_item.json)",
"operationId": "delete_catalog_item",
"parameters": [
{
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Items"
},
"get": {
"description": "Get a specific catalog item with the given item ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_item.json)",
"operationId": "get_catalog_item",
"parameters": [
{
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"price",
"published",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"inventory_policy",
"inventory_quantity",
"price",
"published",
"sku",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"variants"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Items"
},
"patch": {
"description": "Update a catalog item with the given item ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_item.json)",
"operationId": "update_catalog_item",
"parameters": [
{
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-item]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"price",
"published",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogItemUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchCatalogItemResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Items"
}
},
"/api/catalog-items/{id}/categories": {
"get": {
"description": "Get all catalog categories that an item with the given item ID is in.\n\nCatalog categories can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 categories per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_categories_for_catalog_item.json)",
"operationId": "get_categories_for_catalog_item",
"parameters": [
{
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"nullable": true,
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-category]",
"required": false,
"schema": {
"items": {
"enum": [
"external_id",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`ids`: `any`
`item.id`: `equals`
`name`: `contains`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(ids,['$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogCategoryResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Categories for Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"ids": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"item.id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_catalog_item_categories"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Categories"
}
},
"/api/catalog-items/{id}/relationships/categories": {
"delete": {
"description": "Delete catalog category relationships for the given item ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_categories_from_catalog_item.json)",
"operationId": "remove_categories_from_catalog_item",
"parameters": [
{
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogItemCategoryOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Remove Categories from Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"delete_catalog_item_relationships_categories"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Items"
},
"get": {
"description": "Get all catalog categories that a particular item is in. Returns a maximum of 100 categories per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_category_ids_for_catalog_item.json)",
"operationId": "get_category_ids_for_catalog_item",
"parameters": [
{
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"nullable": true,
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`ids`: `any`
`item.id`: `equals`
`name`: `contains`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(ids,['$custom:::$default:::SAMPLE-DATA-CATEGORY-APPAREL'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemCategoriesRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Category IDs for Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"ids": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"item.id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_catalog_item_relationships_categories"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Items"
},
"patch": {
"description": "Update catalog category relationships for the given item ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_categories_for_catalog_item.json)",
"operationId": "update_categories_for_catalog_item",
"parameters": [
{
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogItemCategoryOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Categories for Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"update_catalog_item_relationships_categories"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Items"
},
"post": {
"description": "Create a new catalog category relationship for the given item ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_categories_to_catalog_item.json)",
"operationId": "add_categories_to_catalog_item",
"parameters": [
{
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogItemCategoryOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Add Categories to Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"add_category_to_catalog_item",
"create_catalog_item_relationships_category",
"create_catalog_item_relationships_categories"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Items"
}
},
"/api/catalog-items/{id}/relationships/variants": {
"get": {
"description": "Get all variants related to the given item ID.\n\nVariants can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 variants per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variant_ids_for_catalog_item.json)",
"operationId": "get_variant_ids_for_catalog_item",
"parameters": [
{
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"nullable": true,
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`ids`: `any`
`item.id`: `equals`
`sku`: `equals`
`title`: `contains`
`published`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogItemVariantsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Variant IDs for Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"ids": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"item.id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"published": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"sku": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"title": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_catalog_item_relationships_variants"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Variants"
}
},
"/api/catalog-items/{id}/variants": {
"get": {
"description": "Get all variants related to the given item ID.\n\nVariants can be sorted by the following fields, in ascending and descending order:\n`created`\n\nReturns a maximum of 100 variants per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_variants_for_catalog_item.json)",
"operationId": "get_variants_for_catalog_item",
"parameters": [
{
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1",
"nullable": true,
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"inventory_policy",
"inventory_quantity",
"price",
"published",
"sku",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`ids`: `any`
`item.id`: `equals`
`sku`: `equals`
`title`: `contains`
`published`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogVariantResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Variants for Catalog Item",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"ids": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"item.id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"published": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"sku": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"title": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_catalog_item_variants"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Variants"
}
},
"/api/catalog-variant-bulk-create-jobs": {
"get": {
"description": "Get all catalog variant bulk create jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_jobs.json)",
"operationId": "get_bulk_create_variants_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogVariantCreateJobResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Create Variants Jobs",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_create_variants_jobs",
"get_catalog_variant_bulk_create_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Variants"
},
"post": {
"description": "Create a catalog variant bulk create job to create a batch of catalog variants.\n\nAccepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_catalog_variants.json)",
"operationId": "bulk_create_catalog_variants",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogVariantCreateJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogVariantCreateJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Create Catalog Variants",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"spawn_create_variants_job",
"create_catalog_variant_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Variants"
}
},
"/api/catalog-variant-bulk-create-jobs/{job_id}": {
"get": {
"description": "Get a catalog variant bulk create job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `variants`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_variants_job.json)",
"operationId": "get_bulk_create_variants_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"inventory_policy",
"inventory_quantity",
"price",
"published",
"sku",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"variants"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogVariantCreateJobResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Create Variants Job",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"get_create_variants_job",
"get_catalog_variant_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Variants"
}
},
"/api/catalog-variant-bulk-delete-jobs": {
"get": {
"description": "Get all catalog variant bulk delete jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_jobs.json)",
"operationId": "get_bulk_delete_variants_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogVariantDeleteJobResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Delete Variants Jobs",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_delete_variants_jobs",
"get_catalog_variant_bulk_delete_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Variants"
},
"post": {
"description": "Create a catalog variant bulk delete job to delete a batch of catalog variants.\n\nAccepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_delete_catalog_variants.json)",
"operationId": "bulk_delete_catalog_variants",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogVariantDeleteJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogVariantDeleteJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Delete Catalog Variants",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"spawn_delete_variants_job",
"create_catalog_variant_bulk_delete_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Variants"
}
},
"/api/catalog-variant-bulk-delete-jobs/{job_id}": {
"get": {
"description": "Get a catalog variant bulk delete job with the given job ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_delete_variants_job.json)",
"operationId": "get_bulk_delete_variants_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogVariantDeleteJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Delete Variants Job",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"get_delete_variants_job",
"get_catalog_variant_bulk_delete_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Variants"
}
},
"/api/catalog-variant-bulk-update-jobs": {
"get": {
"description": "Get all catalog variant bulk update jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_jobs.json)",
"operationId": "get_bulk_update_variants_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant-bulk-update-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogVariantUpdateJobResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Update Variants Jobs",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_update_variants_jobs",
"get_catalog_variant_bulk_update_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Variants"
},
"post": {
"description": "Create a catalog variant bulk update job to update a batch of catalog variants.\n\nAccepts up to 100 catalog variants per request. The maximum allowed payload size is 5MB.\nThe maximum number of jobs in progress at one time is 500.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_update_catalog_variants.json)",
"operationId": "bulk_update_catalog_variants",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant-bulk-update-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogVariantUpdateJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogVariantUpdateJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Update Catalog Variants",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"spawn_update_variants_job",
"create_catalog_variant_bulk_update_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Variants"
}
},
"/api/catalog-variant-bulk-update-jobs/{job_id}": {
"get": {
"description": "Get a catalog variate bulk update job with the given job ID.\n\nAn `include` parameter can be provided to get the following related resource data: `variants`.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_update_variants_job.json)",
"operationId": "get_bulk_update_variants_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant-bulk-update-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"inventory_policy",
"inventory_quantity",
"price",
"published",
"sku",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"variants"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogVariantUpdateJobResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Update Variants Job",
"tags": [
"Catalogs"
],
"x-klaviyo-operation-aliases": [
"get_update_variants_job",
"get_catalog_variant_bulk_update_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Variants"
}
},
"/api/catalog-variants": {
"get": {
"description": "Get all variants in an account.\n\nVariants can be sorted by the following fields, in ascending and descending order:\n`created`\n\nCurrently, the only supported integration type is `$custom`, and the only supported catalog type is `$default`.\n\nReturns a maximum of 100 variants per request.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variants.json)",
"operationId": "get_catalog_variants",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"inventory_policy",
"inventory_quantity",
"price",
"published",
"sku",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`ids`: `any`
`item.id`: `equals`
`sku`: `equals`
`title`: `contains`
`published`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(ids,['$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogVariantResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Catalog Variants",
"tags": [
"Catalogs"
],
"x-klaviyo-filters": {
"ids": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"item.id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"published": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"sku": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"title": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Variants"
},
"post": {
"description": "Create a new variant for a related catalog item.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_catalog_variant.json)",
"operationId": "create_catalog_variant",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"inventory_policy",
"inventory_quantity",
"price",
"published",
"sku",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogVariantCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCatalogVariantResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Catalog Variant",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Variants"
}
},
"/api/catalog-variants/{id}": {
"delete": {
"description": "Delete a catalog item variant with the given variant ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_catalog_variant.json)",
"operationId": "delete_catalog_variant",
"parameters": [
{
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Catalog Variant",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Variants"
},
"get": {
"description": "Get a catalog item variant with the given variant ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_catalog_variant.json)",
"operationId": "get_catalog_variant",
"parameters": [
{
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"inventory_policy",
"inventory_quantity",
"price",
"published",
"sku",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCatalogVariantResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Catalog Variant",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:read"
],
"x-klaviyo-subtag": "Variants"
},
"patch": {
"description": "Update a catalog item variant with the given variant ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`catalogs:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_catalog_variant.json)",
"operationId": "update_catalog_variant",
"parameters": [
{
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.",
"example": "$custom:::$default:::SAMPLE-DATA-ITEM-1-VARIANT-MEDIUM",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[catalog-variant]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"custom_metadata",
"description",
"external_id",
"id",
"image_full_url",
"image_thumbnail_url",
"images",
"inventory_policy",
"inventory_quantity",
"price",
"published",
"sku",
"title",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CatalogVariantUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchCatalogVariantResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Catalog Variant",
"tags": [
"Catalogs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"catalogs:write"
],
"x-klaviyo-subtag": "Variants"
}
},
"/api/conversation-messages": {
"post": {
"description": "Send an outbound message to a conversation.\n\nRequires account-level enablement. To request access, reach out in the [developer community](https://community.klaviyo.com/groups/developer-group-64).
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`conversations:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_conversation_message.json)",
"operationId": "create_conversation_message",
"parameters": [
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ConversationMessageCreateQuery"
}
}
},
"description": "Create a conversation message",
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Conversation Message",
"tags": [
"Conversations"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"conversations:write"
]
}
},
"/api/coupon-code-bulk-create-jobs": {
"get": {
"description": "Get all coupon code bulk create jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_code_jobs.json)",
"operationId": "get_bulk_create_coupon_code_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon-code-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponCodeCreateJobResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Create Coupon Code Jobs",
"tags": [
"Coupons"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_coupon_code_bulk_create_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"coupon-codes:read"
]
},
"post": {
"description": "Create a coupon-code-bulk-create-job to bulk create a list of coupon codes.\n\nMax number of coupon codes per job we allow for is 1000.\nMax number of jobs queued at once we allow for is 100.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_coupon_codes.json)",
"operationId": "bulk_create_coupon_codes",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon-code-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CouponCodeCreateJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCouponCodeCreateJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Create Coupon Codes",
"tags": [
"Coupons"
],
"x-klaviyo-operation-aliases": [
"spawn_coupon_code_bulk_create_job",
"create_coupon_code_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"coupon-codes:write"
]
}
},
"/api/coupon-code-bulk-create-jobs/{job_id}": {
"get": {
"description": "Get a coupon code bulk create job with the given job ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_create_coupon_codes_job.json)",
"operationId": "get_bulk_create_coupon_codes_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon-code-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"errors",
"expires_at",
"failed_count",
"id",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon-code]",
"required": false,
"schema": {
"items": {
"enum": [
"expires_at",
"id",
"status",
"unique_code"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"coupon-codes"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponCodeCreateJobResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Create Coupon Codes Job",
"tags": [
"Coupons"
],
"x-klaviyo-operation-aliases": [
"get_coupon_code_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"coupon-codes:read"
]
}
},
"/api/coupon-codes": {
"get": {
"description": "Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles.\n\nA coupon/coupons or a profile/profiles must be provided as required filter params.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes.json)",
"operationId": "get_coupon_codes",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon-code]",
"required": false,
"schema": {
"items": {
"enum": [
"expires_at",
"id",
"status",
"unique_code"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon]",
"required": false,
"schema": {
"items": {
"enum": [
"description",
"external_id",
"id",
"monitor_configuration"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`status`: `equals`
`coupon.id`: `any`, `equals`
`profile.id`: `any`, `equals`",
"in": "query",
"name": "filter",
"required": true,
"schema": {
"example": "equals(coupon.id,'10OFF')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"coupon"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponCodeResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Coupon Codes",
"tags": [
"Coupons"
],
"x-klaviyo-filters": {
"coupon.id": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"expires_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"profile.id": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"UNASSIGNED",
"PROCESSING",
"ASSIGNED_TO_PROFILE",
"VERSION_NOT_ACTIVE",
"DELETING",
"USED"
],
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"coupon-codes:read"
]
},
"post": {
"description": "Synchronously creates a coupon code for the given coupon.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon_code.json)",
"operationId": "create_coupon_code",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon-code]",
"required": false,
"schema": {
"items": {
"enum": [
"expires_at",
"id",
"status",
"unique_code"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CouponCodeCreateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCouponCodeResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Coupon Code",
"tags": [
"Coupons"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"coupon-codes:write"
]
}
},
"/api/coupon-codes/{id}": {
"delete": {
"description": "Deletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the\ncoupon code, an exception will be raised
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_coupon_code.json)",
"operationId": "delete_coupon_code",
"parameters": [
{
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Coupon Code",
"tags": [
"Coupons"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"coupon-codes:write"
]
},
"get": {
"description": "Returns a Coupon Code specified by the given identifier.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code.json)",
"operationId": "get_coupon_code",
"parameters": [
{
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon-code]",
"required": false,
"schema": {
"items": {
"enum": [
"expires_at",
"id",
"status",
"unique_code"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon]",
"required": false,
"schema": {
"items": {
"enum": [
"description",
"external_id",
"id",
"monitor_configuration"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"coupon"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponCodeResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Coupon Code",
"tags": [
"Coupons"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"coupon-codes:read"
]
},
"patch": {
"description": "Updates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and\n'expires_at' of coupon codes.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`coupon-codes:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_coupon_code.json)",
"operationId": "update_coupon_code",
"parameters": [
{
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.",
"example": "10OFF-ASD325FHK324UJDOI2M3JNES99",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon-code]",
"required": false,
"schema": {
"items": {
"enum": [
"expires_at",
"id",
"status",
"unique_code"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CouponCodeUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchCouponCodeResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Coupon Code",
"tags": [
"Coupons"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"coupon-codes:write"
]
}
},
"/api/coupon-codes/{id}/coupon": {
"get": {
"description": "Get the coupon associated with a given coupon code ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_for_coupon_code.json)",
"operationId": "get_coupon_for_coupon_code",
"parameters": [
{
"description": "The ID of the coupon to look up the relationship of.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the coupon to look up the relationship of.",
"example": "10OFF",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon]",
"required": false,
"schema": {
"items": {
"enum": [
"description",
"external_id",
"id",
"monitor_configuration"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Coupon For Coupon Code",
"tags": [
"Coupons"
],
"x-klaviyo-operation-aliases": [
"get_coupon_code_coupon"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"coupons:read"
]
}
},
"/api/coupon-codes/{id}/relationships/coupon": {
"get": {
"description": "Gets the coupon relationship associated with the given coupon code id
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_id_for_coupon_code.json)",
"operationId": "get_coupon_id_for_coupon_code",
"parameters": [
{
"description": "The ID of the coupon to look up the relationship of.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the coupon to look up the relationship of.",
"example": "10OFF",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponCodeCouponRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Coupon ID for Coupon Code",
"tags": [
"Coupons"
],
"x-klaviyo-operation-aliases": [
"get_coupon_relationships_coupon_codes"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"coupons:read"
]
}
},
"/api/coupons": {
"get": {
"description": "Get all coupons in an account.\n\nTo learn more, see our [Coupons API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_coupons_api).
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupons.json)",
"operationId": "get_coupons",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon]",
"required": false,
"schema": {
"items": {
"enum": [
"description",
"external_id",
"id",
"monitor_configuration"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Coupons",
"tags": [
"Coupons"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"coupons:read"
]
},
"post": {
"description": "Creates a new coupon.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`coupons:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_coupon.json)",
"operationId": "create_coupon",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon]",
"required": false,
"schema": {
"items": {
"enum": [
"description",
"external_id",
"id",
"monitor_configuration"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CouponCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCouponResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Coupon",
"tags": [
"Coupons"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"coupons:write"
]
}
},
"/api/coupons/{id}": {
"delete": {
"description": "Delete the coupon with the given coupon ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`coupons:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_coupon.json)",
"operationId": "delete_coupon",
"parameters": [
{
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"example": "10OFF",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Coupon",
"tags": [
"Coupons"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"coupons:write"
]
},
"get": {
"description": "Get a specific coupon with the given coupon ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`coupons:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon.json)",
"operationId": "get_coupon",
"parameters": [
{
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"example": "10OFF",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon]",
"required": false,
"schema": {
"items": {
"enum": [
"description",
"external_id",
"id",
"monitor_configuration"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Coupon",
"tags": [
"Coupons"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"coupons:read"
]
},
"patch": {
"description": "*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`coupons:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_coupon.json)",
"operationId": "update_coupon",
"parameters": [
{
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The internal id of a Coupon is equivalent to its external id stored within an integration.",
"example": "10OFF",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon]",
"required": false,
"schema": {
"items": {
"enum": [
"description",
"external_id",
"id",
"monitor_configuration"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CouponUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchCouponResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Coupon",
"tags": [
"Coupons"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"coupons:write"
]
}
},
"/api/coupons/{id}/coupon-codes": {
"get": {
"description": "Gets a list of coupon codes associated with the given coupon id
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_codes_for_coupon.json)",
"operationId": "get_coupon_codes_for_coupon",
"parameters": [
{
"description": "The ID of the coupon to look up the relationship of.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the coupon to look up the relationship of.",
"example": "10OFF",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[coupon-code]",
"required": false,
"schema": {
"items": {
"enum": [
"expires_at",
"id",
"status",
"unique_code"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`status`: `equals`
`coupon.id`: `any`, `equals`
`profile.id`: `any`, `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "less-than(expires_at,2022-11-08T00:00:00+00:00)",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponCodeResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Coupon Codes for Coupon",
"tags": [
"Coupons"
],
"x-klaviyo-filters": {
"coupon.id": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"expires_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"profile.id": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"UNASSIGNED",
"PROCESSING",
"ASSIGNED_TO_PROFILE",
"VERSION_NOT_ACTIVE",
"DELETING",
"USED"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_coupon_coupon_codes",
"get_codes_for_coupon"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"coupon-codes:read"
]
}
},
"/api/coupons/{id}/relationships/coupon-codes": {
"get": {
"description": "Gets a list of coupon code relationships associated with the given coupon id
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`coupon-codes:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_coupon_code_ids_for_coupon.json)",
"operationId": "get_coupon_code_ids_for_coupon",
"parameters": [
{
"description": "The ID of the coupon to look up the relationship of.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the coupon to look up the relationship of.",
"example": "10OFF",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`status`: `equals`
`coupon.id`: `any`, `equals`
`profile.id`: `any`, `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "less-than(expires_at,2022-11-08T00:00:00+00:00)",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 100. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCouponCodesRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Coupon Code IDs for Coupon",
"tags": [
"Coupons"
],
"x-klaviyo-filters": {
"coupon.id": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"expires_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"profile.id": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"UNASSIGNED",
"PROCESSING",
"ASSIGNED_TO_PROFILE",
"VERSION_NOT_ACTIVE",
"DELETING",
"USED"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_coupon_code_relationships_coupon",
"get_code_ids_for_coupon",
"get_coupon_relationships_codes"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"coupon-codes:read"
]
}
},
"/api/custom-metrics": {
"get": {
"description": "Get all custom metrics in an account.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metrics.json)",
"operationId": "get_custom_metrics",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[custom-metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.aggregation_method",
"definition.metric_groups",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"metrics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCustomMetricResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Custom Metrics",
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
],
"x-klaviyo-subtag": "Custom Metrics"
},
"post": {
"description": "Create a new custom metric.\n\nCustom metric objects must include a `name` and `definition`.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`
Daily: `15/d`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_custom_metric.json)",
"operationId": "create_custom_metric",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[custom-metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.aggregation_method",
"definition.metric_groups",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CustomMetricCreateQuery"
}
}
},
"description": "Create a custom metric.",
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostCustomMetricResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Custom Metric",
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "15/d",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"metrics:write"
],
"x-klaviyo-subtag": "Custom Metrics"
}
},
"/api/custom-metrics/{id}": {
"delete": {
"description": "Delete a custom metric with the given custom metric ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_custom_metric.json)",
"operationId": "delete_custom_metric",
"parameters": [
{
"description": "The ID of the custom metric",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the custom metric",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Custom Metric",
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:write"
],
"x-klaviyo-subtag": "Custom Metrics"
},
"get": {
"description": "Get a custom metric with the given custom metric ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric.json)",
"operationId": "get_custom_metric",
"parameters": [
{
"description": "The ID of the custom metric",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the custom metric",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[custom-metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.aggregation_method",
"definition.metric_groups",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"metrics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCustomMetricResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Custom Metric",
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
],
"x-klaviyo-subtag": "Custom Metrics"
},
"patch": {
"description": "Update a custom metric with the given custom metric ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`
Daily: `15/d`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_custom_metric.json)",
"operationId": "update_custom_metric",
"parameters": [
{
"description": "The ID of the custom metric",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the custom metric",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[custom-metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.aggregation_method",
"definition.metric_groups",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/CustomMetricPartialUpdateQuery"
}
}
},
"description": "Update a custom metric by ID.",
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchCustomMetricResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Custom Metric",
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "15/d",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"metrics:write"
],
"x-klaviyo-subtag": "Custom Metrics"
}
},
"/api/custom-metrics/{id}/metrics": {
"get": {
"description": "Get all metrics for the given custom metric ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics_for_custom_metric.json)",
"operationId": "get_metrics_for_custom_metric",
"parameters": [
{
"description": "The ID of the custom metric",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the custom metric",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metrics for Custom Metric",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_custom_metric_metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
],
"x-klaviyo-subtag": "Custom Metrics"
}
},
"/api/custom-metrics/{id}/relationships/metrics": {
"get": {
"description": "Get all metrics for the given custom metric ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_ids_for_custom_metric.json)",
"operationId": "get_metric_ids_for_custom_metric",
"parameters": [
{
"description": "The ID of the custom metric",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the custom metric",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCustomMetricMetricsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metric IDs for Custom Metric",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_custom_metric_relationships_metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
],
"x-klaviyo-subtag": "Custom Metrics"
}
},
"/api/data-privacy-deletion-jobs": {
"post": {
"description": "Request a deletion for the profiles corresponding to one of the following identifiers: `email`, `phone_number`, or `id`. If multiple identifiers are provided, we will return an error.\n\nAll profiles that match the provided identifier will be deleted.\n\nThe deletion occurs asynchronously; however, once it has completed, the deleted profile will appear on the [Deleted Profiles page](https://www.klaviyo.com/account/deleted).\n\nFor more information on the deletion process, please refer to our [Help Center docs on how to handle GDPR and CCPA deletion requests](https://help.klaviyo.com/hc/en-us/articles/360004217631-How-to-Handle-GDPR-Requests#record-gdpr-and-ccpa%20%20-deletion-requests2).
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`data-privacy:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/request_profile_deletion.json)",
"operationId": "request_profile_deletion",
"parameters": [
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/DataPrivacyCreateDeletionJobQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Request Profile Deletion",
"tags": [
"Data Privacy"
],
"x-klaviyo-operation-aliases": [
"create_data_privacy_deletion_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"data-privacy:write"
]
}
},
"/api/data-source-record-bulk-create-jobs": {
"post": {
"description": "Create a bulk data source record import job to create a batch of records.\n\nAccepts up to 500 records per request. The maximum allowed payload size is 4MB. The maximum allowed payload size per-record is 512KB.\n\nTo learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).
*Rate limits*:
Burst: `3/s`
Steady: `15/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_data_source_records.json)",
"operationId": "bulk_create_data_source_records",
"parameters": [
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/DataSourceRecordBulkCreateJobCreateQuery"
}
}
},
"description": "Create a data source record job",
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Create Data Source Records",
"tags": [
"Custom Objects"
],
"x-klaviyo-operation-aliases": [
"create_data_source_record_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"custom-objects:write"
]
}
},
"/api/data-source-record-create-jobs": {
"post": {
"description": "Create a data source record import job to create a single record.\n\nThe maximum allowed payload size per-record is 512KB.\n\nTo learn more, see our [Custom Objects API overview](https://developers.klaviyo.com/en/reference/custom_objects_api_overview).
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source_record.json)",
"operationId": "create_data_source_record",
"parameters": [
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/DataSourceRecordCreateJobCreateQuery"
}
}
},
"description": "Create a data source record job",
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Data Source Record",
"tags": [
"Custom Objects"
],
"x-klaviyo-operation-aliases": [
"create_data_source_record_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"custom-objects:write"
]
}
},
"/api/data-sources": {
"get": {
"description": "Get all data sources in an account.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`custom-objects:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_sources.json)",
"operationId": "get_data_sources",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[data-source]",
"required": false,
"schema": {
"items": {
"enum": [
"description",
"id",
"namespace",
"title",
"visibility"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetDataSourceResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Data Sources",
"tags": [
"Custom Objects"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"custom-objects:read"
]
},
"post": {
"description": "Create a new data source in an account
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source.json)",
"operationId": "create_data_source",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[data-source]",
"required": false,
"schema": {
"items": {
"enum": [
"description",
"id",
"namespace",
"title",
"visibility"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/DataSourceCreateQuery"
}
}
},
"description": "Create data source",
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostDataSourceResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Data Source",
"tags": [
"Custom Objects"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"custom-objects:write"
]
}
},
"/api/data-sources/{id}": {
"delete": {
"description": "Delete a data source in an account.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_data_source.json)",
"operationId": "delete_data_source",
"parameters": [
{
"description": "The ID of the data source to delete",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the data source to delete",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Data Source",
"tags": [
"Custom Objects"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"custom-objects:write"
]
},
"get": {
"description": "Retrieve a data source in an account.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`custom-objects:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_data_source.json)",
"operationId": "get_data_source",
"parameters": [
{
"description": "The ID of the data source",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the data source",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[data-source]",
"required": false,
"schema": {
"items": {
"enum": [
"description",
"id",
"namespace",
"title",
"visibility"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetDataSourceResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Data Source",
"tags": [
"Custom Objects"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"custom-objects:read"
]
}
},
"/api/event-bulk-create-jobs": {
"post": {
"description": "Create a batch of events for one or more profiles.\n\nNote that this endpoint allows you to create new profiles or update existing profile properties.\n\nAt a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively.\n\nAccepts up to 1,000 events per request. The maximum allowed payload size is 5MB. A single string cannot exceed 100KB.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_events.json)",
"operationId": "bulk_create_events",
"parameters": [
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/EventsBulkCreateJob"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Create Events",
"tags": [
"Events"
],
"x-klaviyo-operation-aliases": [
"create_event_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"events:write"
]
}
},
"/api/events": {
"get": {
"description": "Get all events in an account\n\nRequests can be sorted by the following fields:\n`datetime`, `timestamp`\n\n[Custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview) are not supported in the `metric_id` filter.\n\nReturns a maximum of 200 events per page.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_events.json)",
"operationId": "get_events",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[attribution]",
"required": false,
"schema": {
"items": {
"enum": [
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[event]",
"required": false,
"schema": {
"items": {
"enum": [
"datetime",
"event_properties",
"id",
"timestamp",
"uuid"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`metric_id`: `equals`
`profile_id`: `equals`
`profile`: `has`
`metric`: `has`
`datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(metric_id,'example')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"attributions",
"metric",
"profile"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 200. Min: 1. Max: 1000.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 200,
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"datetime",
"-datetime",
"timestamp",
"-timestamp"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetEventResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Events",
"tags": [
"Events"
],
"x-klaviyo-filters": {
"datetime": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"metric": {
"operators": {
"none": [
"has"
]
}
},
"metric_id": {
"operators": {
"list": [
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"profile": {
"operators": {
"none": [
"has"
]
}
},
"profile_id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"timestamp": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"type": "number"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"events:read"
]
},
"post": {
"description": "Create a new event to track a profile's activity.\n\nNote that this endpoint allows you to create a new profile or update an existing profile's properties.\n\nAt a minimum, profile and metric objects should include at least one profile identifier (e.g., `id`, `email`, or `phone_number`) and the metric `name`, respectively.\n\nSuccessful response indicates that the event was validated and submitted for processing, but does not guarantee that processing is complete.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_event.json)",
"operationId": "create_event",
"parameters": [
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/EventCreateQueryV2"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Event",
"tags": [
"Events"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"events:write"
]
}
},
"/api/events/{id}": {
"get": {
"description": "Get an event with the given event ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`events:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_event.json)",
"operationId": "get_event",
"parameters": [
{
"description": "ID of the event",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the event",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[attribution]",
"required": false,
"schema": {
"items": {
"enum": [
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[event]",
"required": false,
"schema": {
"items": {
"enum": [
"datetime",
"event_properties",
"id",
"timestamp",
"uuid"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"attributions",
"metric",
"profile"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetEventResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Event",
"tags": [
"Events"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"events:read"
]
}
},
"/api/events/{id}/metric": {
"get": {
"description": "Get the metric for an event with the given event ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_event.json)",
"operationId": "get_metric_for_event",
"parameters": [
{
"description": "ID of the event",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the event",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metric for Event",
"tags": [
"Events"
],
"x-klaviyo-operation-aliases": [
"get_event_metric"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"events:read",
"metrics:read"
]
}
},
"/api/events/{id}/profile": {
"get": {
"description": "Get the profile associated with an event with the given event ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_event.json)",
"operationId": "get_profile_for_event",
"parameters": [
{
"description": "ID of the event",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the event",
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
"explode": false,
"in": "query",
"name": "additional-fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"subscriptions",
"predictive_analytics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profile for Event",
"tags": [
"Events"
],
"x-klaviyo-operation-aliases": [
"get_event_profile"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"events:read",
"profiles:read"
]
}
},
"/api/events/{id}/relationships/metric": {
"get": {
"description": "Get a list of related Metrics for an Event
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_event.json)",
"operationId": "get_metric_id_for_event",
"parameters": [
{
"description": "ID of the event",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the event",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetEventMetricRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metric ID for Event",
"tags": [
"Events"
],
"x-klaviyo-operation-aliases": [
"get_event_relationships_metric"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"events:read",
"metrics:read"
]
}
},
"/api/events/{id}/relationships/profile": {
"get": {
"description": "Get profile [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for an event with the given event ID.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`events:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_event.json)",
"operationId": "get_profile_id_for_event",
"parameters": [
{
"description": "ID of the event",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the event",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetEventProfileRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profile ID for Event",
"tags": [
"Events"
],
"x-klaviyo-operation-aliases": [
"get_event_relationships_profile"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"events:read",
"profiles:read"
]
}
},
"/api/flow-actions/{id}": {
"delete": {
"description": "Delete a flow action.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_flow_action.json)",
"operationId": "delete_flow_action",
"parameters": [
{
"description": "ID of the flow action to delete. Ex: 01GDDKASAP8TKDDA2GRZDSVP4H",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the flow action to delete. Ex: 01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Flow Action",
"tags": [
"Flows"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:write"
]
},
"get": {
"description": "Get a flow action from a flow with the given flow action ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action.json)",
"operationId": "get_flow_action",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-action]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.action_buttons",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.vendor_id",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.message.web_url",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.action_buttons",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.message.web_url",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-message]",
"required": false,
"schema": {
"items": {
"enum": [
"channel",
"created",
"definition",
"definition.action_buttons",
"definition.add_info_link",
"definition.add_opt_out_language",
"definition.add_org_prefix",
"definition.add_tracking_params",
"definition.additional_filters",
"definition.additional_filters.condition_groups",
"definition.android_link",
"definition.badge",
"definition.badge_options",
"definition.badge_options.badge_config",
"definition.badge_options.set_from_property",
"definition.badge_options.value",
"definition.bcc_email",
"definition.body",
"definition.cc_email",
"definition.conversion_metric_id",
"definition.custom_tracking_params",
"definition.dynamic_image",
"definition.from_email",
"definition.from_label",
"definition.headers",
"definition.id",
"definition.image_id",
"definition.include_contact_card",
"definition.ios_link",
"definition.kv_pairs",
"definition.name",
"definition.on_open",
"definition.preview_text",
"definition.push_type",
"definition.reply_to_email",
"definition.shorten_links",
"definition.smart_sending_enabled",
"definition.sms_quiet_hours_enabled",
"definition.sound",
"definition.subject_line",
"definition.template_id",
"definition.title",
"definition.to_emails",
"definition.transactional",
"definition.url",
"definition.vendor_id",
"definition.video_asset_id",
"definition.web_url",
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"flow",
"flow-messages"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowActionEncodedResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Flow Action",
"tags": [
"Flows"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
},
"patch": {
"description": "Update a flow action.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow_action.json)",
"operationId": "update_flow_action",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-action]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.action_buttons",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.vendor_id",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.message.web_url",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.action_buttons",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.message.web_url",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/FlowActionUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchFlowActionEncodedResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Flow Action",
"tags": [
"Flows"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:write"
]
}
},
"/api/flow-actions/{id}/flow": {
"get": {
"description": "Get the flow associated with the given action ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_for_flow_action.json)",
"operationId": "get_flow_for_flow_action",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Flow for Flow Action",
"tags": [
"Flows"
],
"x-klaviyo-operation-aliases": [
"get_flow_action_flow"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flow-actions/{id}/flow-messages": {
"get": {
"description": "Get all flow messages associated with the given flow action ID.\n\nReturns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_action_messages.json)",
"operationId": "get_flow_action_messages",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-message]",
"required": false,
"schema": {
"items": {
"enum": [
"channel",
"created",
"definition",
"definition.action_buttons",
"definition.add_info_link",
"definition.add_opt_out_language",
"definition.add_org_prefix",
"definition.add_tracking_params",
"definition.additional_filters",
"definition.additional_filters.condition_groups",
"definition.android_link",
"definition.badge",
"definition.badge_options",
"definition.badge_options.badge_config",
"definition.badge_options.set_from_property",
"definition.badge_options.value",
"definition.bcc_email",
"definition.body",
"definition.cc_email",
"definition.conversion_metric_id",
"definition.custom_tracking_params",
"definition.dynamic_image",
"definition.from_email",
"definition.from_label",
"definition.headers",
"definition.id",
"definition.image_id",
"definition.include_contact_card",
"definition.ios_link",
"definition.kv_pairs",
"definition.name",
"definition.on_open",
"definition.preview_text",
"definition.push_type",
"definition.reply_to_email",
"definition.shorten_links",
"definition.smart_sending_enabled",
"definition.sms_quiet_hours_enabled",
"definition.sound",
"definition.subject_line",
"definition.template_id",
"definition.title",
"definition.to_emails",
"definition.transactional",
"definition.url",
"definition.vendor_id",
"definition.video_asset_id",
"definition.web_url",
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`name`: `contains`, `ends-with`, `equals`, `starts-with`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(id,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 50. Min: 1. Max: 50.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 50,
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created",
"id",
"-id",
"name",
"-name",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowMessageEncodedResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Messages For Flow Action",
"tags": [
"Flows"
],
"x-klaviyo-filters": {
"created": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"single": [
"contains",
"ends-with",
"equals",
"starts-with"
]
},
"value": {
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_messages_for_flow_action"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flow-actions/{id}/relationships/flow": {
"get": {
"description": "Get the flow associated with the given action ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_id_for_flow_action.json)",
"operationId": "get_flow_id_for_flow_action",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowActionFlowRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Flow ID for Flow Action",
"tags": [
"Flows"
],
"x-klaviyo-operation-aliases": [
"get_flow_action_relationships_flow"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flow-actions/{id}/relationships/flow-messages": {
"get": {
"description": "Get all relationships for flow messages associated with the given flow action ID.\n\nReturns a maximum of 50 flow message relationships per request, which can be paginated with cursor-based pagination.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_message_ids_for_flow_action.json)",
"operationId": "get_message_ids_for_flow_action",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`name`: `contains`, `ends-with`, `equals`, `starts-with`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(name,'example')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 50. Min: 1. Max: 50.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 50,
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created",
"id",
"-id",
"name",
"-name",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowActionFlowMessageRelationshipResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Message IDs for Flow Action",
"tags": [
"Flows"
],
"x-klaviyo-filters": {
"created": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"name": {
"operators": {
"single": [
"contains",
"ends-with",
"equals",
"starts-with"
]
},
"value": {
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_flow_action_relationships_messages"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flow-messages/{id}": {
"get": {
"description": "Get a flow message from a flow with the given flow message ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_message.json)",
"operationId": "get_flow_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-action]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.action_buttons",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.vendor_id",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.message.web_url",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.action_buttons",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.message.web_url",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-message]",
"required": false,
"schema": {
"items": {
"enum": [
"channel",
"created",
"definition",
"definition.action_buttons",
"definition.add_info_link",
"definition.add_opt_out_language",
"definition.add_org_prefix",
"definition.add_tracking_params",
"definition.additional_filters",
"definition.additional_filters.condition_groups",
"definition.android_link",
"definition.badge",
"definition.badge_options",
"definition.badge_options.badge_config",
"definition.badge_options.set_from_property",
"definition.badge_options.value",
"definition.bcc_email",
"definition.body",
"definition.cc_email",
"definition.conversion_metric_id",
"definition.custom_tracking_params",
"definition.dynamic_image",
"definition.from_email",
"definition.from_label",
"definition.headers",
"definition.id",
"definition.image_id",
"definition.include_contact_card",
"definition.ios_link",
"definition.kv_pairs",
"definition.name",
"definition.on_open",
"definition.preview_text",
"definition.push_type",
"definition.reply_to_email",
"definition.shorten_links",
"definition.smart_sending_enabled",
"definition.sms_quiet_hours_enabled",
"definition.sound",
"definition.subject_line",
"definition.template_id",
"definition.title",
"definition.to_emails",
"definition.transactional",
"definition.url",
"definition.vendor_id",
"definition.video_asset_id",
"definition.web_url",
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"flow-action",
"template"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowMessageEncodedResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Flow Message",
"tags": [
"Flows"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flow-messages/{id}/flow-action": {
"get": {
"description": "Get the flow action for a flow message with the given message ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_for_flow_message.json)",
"operationId": "get_action_for_flow_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-action]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.action_buttons",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.vendor_id",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.message.web_url",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.action_buttons",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.message.web_url",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowActionEncodedResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Action for Flow Message",
"tags": [
"Flows"
],
"x-klaviyo-operation-aliases": [
"get_flow_message_action"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flow-messages/{id}/relationships/flow-action": {
"get": {
"description": "Get the [relationship](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a flow message's flow action, given the flow ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_id_for_flow_message.json)",
"operationId": "get_action_id_for_flow_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowMessageActionRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Action ID for Flow Message",
"tags": [
"Flows"
],
"x-klaviyo-operation-aliases": [
"get_flow_message_relationships_action"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flow-messages/{id}/relationships/template": {
"get": {
"description": "Returns the ID of the related template
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_id_for_flow_message.json)",
"operationId": "get_template_id_for_flow_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowMessageTemplateRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Template ID for Flow Message",
"tags": [
"Flows"
],
"x-klaviyo-operation-aliases": [
"get_flow_message_relationships_template"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"templates:read"
]
}
},
"/api/flow-messages/{id}/template": {
"get": {
"description": "Return the related template
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template_for_flow_message.json)",
"operationId": "get_template_for_flow_message",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTemplateResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Template for Flow Message",
"tags": [
"Flows"
],
"x-klaviyo-operation-aliases": [
"get_flow_message_template"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"templates:read"
]
}
},
"/api/flow-series-reports": {
"post": {
"description": "Returns the requested flow analytics series data
*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_series.json)",
"operationId": "query_flow_series",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-series-report]",
"required": false,
"schema": {
"items": {
"enum": [
"date_times",
"id",
"results"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page_cursor",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/FlowSeriesRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostFlowSeriesResponseDTO"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Query Flow Series",
"tags": [
"Reporting"
],
"x-klaviyo-operation-aliases": [
"create_flow_sery_report",
"create_flow_series_report"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "225/d",
"steady": "2/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flow-values-reports": {
"post": {
"description": "Returns the requested flow analytics values data
*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_flow_values.json)",
"operationId": "query_flow_values",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-values-report]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"results"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page_cursor",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/FlowValuesRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostFlowValuesResponseDTO"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Query Flow Values",
"tags": [
"Reporting"
],
"x-klaviyo-operation-aliases": [
"create_flow_value_report",
"create_flow_values_report"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "225/d",
"steady": "2/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flows": {
"get": {
"description": "Get all flows in an account.\n\nReturns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows.json)",
"operationId": "get_flows",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-action]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.action_buttons",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.vendor_id",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.message.web_url",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.action_buttons",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.message.web_url",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`name`: `contains`, `ends-with`, `equals`, `starts-with`
`status`: `equals`
`archived`: `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`trigger_type`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(id,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"flow-actions",
"tags"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 50. Min: 1. Max: 50.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 50,
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created",
"id",
"-id",
"name",
"-name",
"status",
"-status",
"trigger_type",
"-trigger_type",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Flows",
"tags": [
"Flows"
],
"x-klaviyo-filters": {
"archived": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"created": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"single": [
"contains",
"ends-with",
"equals",
"starts-with"
]
},
"value": {
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"trigger_type": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"Metric",
"Added to List",
"Unconfigured",
"Date Based",
"Price Drop",
"Low Inventory"
],
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
},
"post": {
"description": "Create a new flow using an encoded flow definition.\n\nNew objects within the flow definition, such as actions, will need to use a\n`temporary_id` field for identification. These will be replaced with traditional `id` fields\nafter successful creation.\n\nA successful request will return the new definition to you.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`
Daily: `100/d`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_flow.json)",
"operationId": "create_flow",
"parameters": [
{
"description": "Request additional fields not included by default in the response. Supported values: 'definition'",
"explode": false,
"in": "query",
"name": "additional-fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"definition"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"definition",
"definition.actions",
"definition.entry_action_id",
"definition.profile_filter",
"definition.profile_filter.condition_groups",
"definition.reentry_criteria",
"definition.reentry_criteria.duration",
"definition.reentry_criteria.unit",
"definition.triggers",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/FlowCreateQuery"
}
}
},
"description": "Creates a Flow from parameters",
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostFlowV2Response"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Flow",
"tags": [
"Flows"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "100/d",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"flows:write"
]
}
},
"/api/flows/{id}": {
"delete": {
"description": "Delete a flow with the given flow ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_flow.json)",
"operationId": "delete_flow",
"parameters": [
{
"description": "ID of the Flow to delete. Ex: XVTP5Q",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Flow to delete. Ex: XVTP5Q",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Flow",
"tags": [
"Flows"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:write"
]
},
"get": {
"description": "Get a flow with the given flow ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow.json)",
"operationId": "get_flow",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'definition'",
"explode": false,
"in": "query",
"name": "additional-fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"definition"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-action]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.action_buttons",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.vendor_id",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.message.web_url",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.action_buttons",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.message.web_url",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"definition",
"definition.actions",
"definition.entry_action_id",
"definition.profile_filter",
"definition.profile_filter.condition_groups",
"definition.reentry_criteria",
"definition.reentry_criteria.duration",
"definition.reentry_criteria.unit",
"definition.triggers",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"flow-actions",
"tags"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowV2ResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Flow",
"tags": [
"Flows"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
},
"patch": {
"description": "Update the status of a flow with the given flow ID, and all actions in that flow.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_flow.json)",
"operationId": "update_flow",
"parameters": [
{
"description": "ID of the Flow to update. Ex: XVTP5Q",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "ID of the Flow to update. Ex: XVTP5Q",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/FlowUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchFlowResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Flow Status",
"tags": [
"Flows"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:write"
]
}
},
"/api/flows/{id}/flow-actions": {
"get": {
"description": "Get all flow actions associated with the given flow ID.\n\nReturns a maximum of 50 flows per request, which can be paginated with cursor-based pagination.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_actions_for_flow.json)",
"operationId": "get_actions_for_flow",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow-action]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.data",
"definition.data.action_output_filter",
"definition.data.action_output_filter.condition_groups",
"definition.data.branches",
"definition.data.current_experiment",
"definition.data.current_experiment.allocations",
"definition.data.current_experiment.automatic_winner_selection_settings",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_date",
"definition.data.current_experiment.automatic_winner_selection_settings.automatic_end_statistical_certainty",
"definition.data.current_experiment.automatic_winner_selection_settings.enabled",
"definition.data.current_experiment.id",
"definition.data.current_experiment.name",
"definition.data.current_experiment.started",
"definition.data.current_experiment.variations",
"definition.data.current_experiment.winner_metric",
"definition.data.delay_until_time",
"definition.data.delay_until_weekdays",
"definition.data.experiment_status",
"definition.data.list_id",
"definition.data.main_action",
"definition.data.main_action.data",
"definition.data.main_action.data.message",
"definition.data.main_action.data.message.action_buttons",
"definition.data.main_action.data.message.add_info_link",
"definition.data.main_action.data.message.add_opt_out_language",
"definition.data.main_action.data.message.add_org_prefix",
"definition.data.main_action.data.message.add_tracking_params",
"definition.data.main_action.data.message.additional_filters",
"definition.data.main_action.data.message.additional_filters.condition_groups",
"definition.data.main_action.data.message.android_link",
"definition.data.main_action.data.message.badge",
"definition.data.main_action.data.message.badge_options",
"definition.data.main_action.data.message.badge_options.badge_config",
"definition.data.main_action.data.message.badge_options.set_from_property",
"definition.data.main_action.data.message.badge_options.value",
"definition.data.main_action.data.message.bcc_email",
"definition.data.main_action.data.message.body",
"definition.data.main_action.data.message.cc_email",
"definition.data.main_action.data.message.conversion_metric_id",
"definition.data.main_action.data.message.custom_tracking_params",
"definition.data.main_action.data.message.dynamic_image",
"definition.data.main_action.data.message.from_email",
"definition.data.main_action.data.message.from_label",
"definition.data.main_action.data.message.id",
"definition.data.main_action.data.message.image_id",
"definition.data.main_action.data.message.include_contact_card",
"definition.data.main_action.data.message.ios_link",
"definition.data.main_action.data.message.kv_pairs",
"definition.data.main_action.data.message.name",
"definition.data.main_action.data.message.on_open",
"definition.data.main_action.data.message.preview_text",
"definition.data.main_action.data.message.push_type",
"definition.data.main_action.data.message.reply_to_email",
"definition.data.main_action.data.message.shorten_links",
"definition.data.main_action.data.message.smart_sending_enabled",
"definition.data.main_action.data.message.sms_quiet_hours_enabled",
"definition.data.main_action.data.message.sound",
"definition.data.main_action.data.message.subject_line",
"definition.data.main_action.data.message.template_id",
"definition.data.main_action.data.message.title",
"definition.data.main_action.data.message.transactional",
"definition.data.main_action.data.message.vendor_id",
"definition.data.main_action.data.message.video_asset_id",
"definition.data.main_action.data.message.web_url",
"definition.data.main_action.data.status",
"definition.data.main_action.id",
"definition.data.main_action.links",
"definition.data.main_action.links.next",
"definition.data.main_action.temporary_id",
"definition.data.main_action.type",
"definition.data.message",
"definition.data.message.action_buttons",
"definition.data.message.add_info_link",
"definition.data.message.add_opt_out_language",
"definition.data.message.add_org_prefix",
"definition.data.message.add_tracking_params",
"definition.data.message.additional_filters",
"definition.data.message.additional_filters.condition_groups",
"definition.data.message.android_link",
"definition.data.message.badge",
"definition.data.message.badge_options",
"definition.data.message.badge_options.badge_config",
"definition.data.message.badge_options.set_from_property",
"definition.data.message.badge_options.value",
"definition.data.message.bcc_email",
"definition.data.message.body",
"definition.data.message.cc_email",
"definition.data.message.conversion_metric_id",
"definition.data.message.custom_tracking_params",
"definition.data.message.dynamic_image",
"definition.data.message.from_email",
"definition.data.message.from_label",
"definition.data.message.headers",
"definition.data.message.id",
"definition.data.message.image_id",
"definition.data.message.include_contact_card",
"definition.data.message.ios_link",
"definition.data.message.kv_pairs",
"definition.data.message.name",
"definition.data.message.on_open",
"definition.data.message.preview_text",
"definition.data.message.push_type",
"definition.data.message.reply_to_email",
"definition.data.message.shorten_links",
"definition.data.message.smart_sending_enabled",
"definition.data.message.sms_quiet_hours_enabled",
"definition.data.message.sound",
"definition.data.message.subject_line",
"definition.data.message.template_id",
"definition.data.message.title",
"definition.data.message.to_emails",
"definition.data.message.transactional",
"definition.data.message.url",
"definition.data.message.vendor_id",
"definition.data.message.video_asset_id",
"definition.data.message.web_url",
"definition.data.name",
"definition.data.on_execution",
"definition.data.profile_filter",
"definition.data.profile_filter.condition_groups",
"definition.data.profile_operations",
"definition.data.secondary_value",
"definition.data.service_configuration",
"definition.data.service_configuration.event_key",
"definition.data.service_configuration.event_payload",
"definition.data.service_configuration.report_id",
"definition.data.service_configuration.service_method_type",
"definition.data.service_configuration.tracking_company_id",
"definition.data.status",
"definition.data.target_days",
"definition.data.target_time",
"definition.data.timezone",
"definition.data.trigger_filter",
"definition.data.trigger_filter.condition_groups",
"definition.data.trigger_id",
"definition.data.trigger_subtype",
"definition.data.trigger_type",
"definition.data.unit",
"definition.data.value",
"definition.id",
"definition.links",
"definition.links.next",
"definition.links.next_if_false",
"definition.links.next_if_true",
"definition.temporary_id",
"definition.type",
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`action_type`: `any`, `equals`
`status`: `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(id,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 50. Min: 1. Max: 50.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 50,
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"action_type",
"-action_type",
"created",
"-created",
"id",
"-id",
"status",
"-status",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowActionEncodedResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Actions for Flow",
"tags": [
"Flows"
],
"x-klaviyo-filters": {
"action_type": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"created": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_flow_flow_actions",
"get_flow_actions"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flows/{id}/relationships/flow-actions": {
"get": {
"description": "Get all [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for flow actions associated with the given flow ID.\n\nReturns a maximum of 100 flows per request, which can be paginated with cursor-based pagination.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_action_ids_for_flow.json)",
"operationId": "get_action_ids_for_flow",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`
`action_type`: `any`, `equals`
`status`: `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "any(id,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 50. Min: 1. Max: 50.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 50,
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"action_type",
"-action_type",
"created",
"-created",
"id",
"-id",
"status",
"-status",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowFlowActionRelationshipListResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Action IDs for Flow",
"tags": [
"Flows"
],
"x-klaviyo-filters": {
"action_type": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"created": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any"
]
},
"value": {
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_flow_relationships_flow_actions",
"get_flow_relationships_actions"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read"
]
}
},
"/api/flows/{id}/relationships/tags": {
"get": {
"description": "Return the tag IDs of all tags associated with the given flow.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_flow.json)",
"operationId": "get_tag_ids_for_flow",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowTagsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tag IDs for Flow",
"tags": [
"Flows"
],
"x-klaviyo-operation-aliases": [
"get_flow_relationships_tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read",
"tags:read"
]
}
},
"/api/flows/{id}/tags": {
"get": {
"description": "Return all tags associated with the given flow ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_flow.json)",
"operationId": "get_tags_for_flow",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tags for Flow",
"tags": [
"Flows"
],
"x-klaviyo-operation-aliases": [
"get_flow_tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read",
"tags:read"
]
}
},
"/api/form-series-reports": {
"post": {
"description": "Returns the requested form analytics series data.
*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_series.json)",
"operationId": "query_form_series",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[form-series-report]",
"required": false,
"schema": {
"items": {
"enum": [
"date_times",
"id",
"results"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/FormSeriesRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostFormSeriesResponseDTO"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Query Form Series",
"tags": [
"Reporting"
],
"x-klaviyo-operation-aliases": [
"create_form_sery_report",
"create_form_series_report"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "225/d",
"steady": "2/m"
},
"x-klaviyo-scopes": [
"forms:read"
]
}
},
"/api/form-values-reports": {
"post": {
"description": "Returns the requested form analytics values data.
*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_form_values.json)",
"operationId": "query_form_values",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[form-values-report]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"results"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/FormValuesRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostFormValuesResponseDTO"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Query Form Values",
"tags": [
"Reporting"
],
"x-klaviyo-operation-aliases": [
"create_form_value_report",
"create_form_values_report"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "225/d",
"steady": "2/m"
},
"x-klaviyo-scopes": [
"forms:read"
]
}
},
"/api/form-versions/{id}": {
"get": {
"description": "Get the form version with the given ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_version.json)",
"operationId": "get_form_version",
"parameters": [
{
"description": "The ID of the form version",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the form version",
"example": "1234567",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[form-version]",
"required": false,
"schema": {
"items": {
"enum": [
"ab_test",
"ab_test.variation_name",
"created_at",
"form_type",
"id",
"status",
"updated_at",
"variation_name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[form]",
"required": false,
"schema": {
"items": {
"enum": [
"ab_test",
"created_at",
"id",
"name",
"status",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"form"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFormVersionResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Form Version",
"tags": [
"Forms"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"forms:read"
]
}
},
"/api/form-versions/{id}/form": {
"get": {
"description": "Get the form associated with the given form version.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_for_form_version.json)",
"operationId": "get_form_for_form_version",
"parameters": [
{
"description": "The ID of the form version",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the form version",
"example": "1234567",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[form]",
"required": false,
"schema": {
"items": {
"enum": [
"ab_test",
"created_at",
"id",
"name",
"status",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFormResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Form for Form Version",
"tags": [
"Forms"
],
"x-klaviyo-operation-aliases": [
"get_form_version_form"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"forms:read"
]
}
},
"/api/form-versions/{id}/relationships/form": {
"get": {
"description": "Get the ID of the form associated with the given form version.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form_id_for_form_version.json)",
"operationId": "get_form_id_for_form_version",
"parameters": [
{
"description": "The ID of the form version",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the form version",
"example": "1234567",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFormVersionFormRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Form ID for Form Version",
"tags": [
"Forms"
],
"x-klaviyo-operation-aliases": [
"get_form_version_relationships_form"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"forms:read"
]
}
},
"/api/forms": {
"get": {
"description": "Get all forms in an account.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_forms.json)",
"operationId": "get_forms",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[form]",
"required": false,
"schema": {
"items": {
"enum": [
"ab_test",
"created_at",
"id",
"name",
"status",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`, `equals`
`name`: `any`, `contains`, `equals`
`ab_test`: `equals`
`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`status`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(id,'Y6nRLr')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFormResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Forms",
"tags": [
"Forms"
],
"x-klaviyo-filters": {
"ab_test": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"created_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"contains",
"equals"
]
},
"value": {
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"live",
"draft"
],
"type": "string"
}
},
"updated_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"forms:read"
]
},
"post": {
"description": "Create a new form.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`forms:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_form.json)",
"operationId": "create_form",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[form]",
"required": false,
"schema": {
"items": {
"enum": [
"ab_test",
"created_at",
"definition",
"definition.versions",
"id",
"name",
"status",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/FormCreateQuery"
}
}
},
"description": "Creates a Form from parameters",
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostEncodedFormResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Form",
"tags": [
"Forms"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"forms:write"
]
}
},
"/api/forms/{id}": {
"delete": {
"description": "Delete a given form.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`forms:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_form.json)",
"operationId": "delete_form",
"parameters": [
{
"description": "The ID of the form",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the form",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Form",
"tags": [
"Forms"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"forms:write"
]
},
"get": {
"description": "Get the form with the given ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_form.json)",
"operationId": "get_form",
"parameters": [
{
"description": "The ID of the form",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the form",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[form]",
"required": false,
"schema": {
"items": {
"enum": [
"ab_test",
"created_at",
"definition",
"definition.versions",
"id",
"name",
"status",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetEncodedFormResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Form",
"tags": [
"Forms"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"forms:read"
]
}
},
"/api/forms/{id}/form-versions": {
"get": {
"description": "Get the form versions for the given form.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_versions_for_form.json)",
"operationId": "get_versions_for_form",
"parameters": [
{
"description": "The ID of the form",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the form",
"example": "Y6nRLr",
"nullable": true,
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[form-version]",
"required": false,
"schema": {
"items": {
"enum": [
"ab_test",
"ab_test.variation_name",
"created_at",
"form_type",
"id",
"status",
"updated_at",
"variation_name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`form_type`: `any`, `equals`
`status`: `equals`
`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(form_type,'popup')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFormVersionResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Versions for Form",
"tags": [
"Forms"
],
"x-klaviyo-filters": {
"created_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"form_type": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"enum": [
"popup",
"embed",
"full_page",
"flyout",
"banner"
],
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"live",
"draft"
],
"type": "string"
}
},
"updated_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_form_form_versions",
"get_form_versions"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"forms:read"
]
}
},
"/api/forms/{id}/relationships/form-versions": {
"get": {
"description": "Get the IDs of the form versions for the given form.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`forms:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_version_ids_for_form.json)",
"operationId": "get_version_ids_for_form",
"parameters": [
{
"description": "The ID of the form",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the form",
"example": "Y6nRLr",
"nullable": true,
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`form_type`: `any`, `equals`
`status`: `equals`
`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(form_type,'popup')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created_at",
"-created_at",
"updated_at",
"-updated_at"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFormVersionsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Version IDs for Form",
"tags": [
"Forms"
],
"x-klaviyo-filters": {
"created_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"form_type": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"enum": [
"popup",
"embed",
"full_page",
"flyout",
"banner"
],
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"live",
"draft"
],
"type": "string"
}
},
"updated_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_form_relationships_form_versions",
"get_form_relationships_versions"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"forms:read"
]
}
},
"/api/image-upload": {
"post": {
"description": "Upload an image from a file.\n\nIf you want to import an image from an existing url or a data uri, use the Upload Image From URL endpoint instead.
*Rate limits*:
Burst: `3/s`
Steady: `100/m`
Daily: `100/d`\n\n**Scopes:**\n`images:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/upload_image_from_url.json)",
"operationId": "upload_image_from_file",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[image]",
"required": false,
"schema": {
"items": {
"enum": [
"format",
"hidden",
"id",
"image_url",
"name",
"size",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/ImageUploadQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostImageResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Upload Image From File",
"tags": [
"Images"
],
"x-klaviyo-operation-aliases": [
"create_image_upload"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"daily": "500/d",
"steady": "100/m"
},
"x-klaviyo-scopes": [
"images:write"
]
}
},
"/api/images": {
"get": {
"description": "Get all images in an account.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_images.json)",
"operationId": "get_images",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[image]",
"required": false,
"schema": {
"items": {
"enum": [
"format",
"hidden",
"id",
"image_url",
"name",
"size",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`, `equals`
`updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`format`: `any`, `equals`
`name`: `any`, `contains`, `ends-with`, `equals`, `starts-with`
`size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`hidden`: `any`, `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(id,'7')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"format",
"-format",
"id",
"-id",
"name",
"-name",
"size",
"-size",
"updated_at",
"-updated_at"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetImageResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Images",
"tags": [
"Images"
],
"x-klaviyo-filters": {
"format": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"hidden": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"id": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"contains",
"ends-with",
"equals",
"starts-with"
]
},
"value": {
"type": "string"
}
},
"size": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"type": "integer"
}
},
"updated_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"images:read"
]
},
"post": {
"description": "Import an image from a url or data uri.\n\nIf you want to upload an image from a file, use the Upload Image From File endpoint instead.
*Rate limits*:
Burst: `3/s`
Steady: `100/m`
Daily: `100/d`\n\n**Scopes:**\n`images:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/upload_image_from_url.json)",
"operationId": "upload_image_from_url",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[image]",
"required": false,
"schema": {
"items": {
"enum": [
"format",
"hidden",
"id",
"image_url",
"name",
"size",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ImageCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostImageResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Upload Image From URL",
"tags": [
"Images"
],
"x-klaviyo-operation-aliases": [
"create_image"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"daily": "100/d",
"steady": "100/m"
},
"x-klaviyo-scopes": [
"images:write"
]
}
},
"/api/images/{id}": {
"get": {
"description": "Get the image with the given image ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`images:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_image.json)",
"operationId": "get_image",
"parameters": [
{
"description": "The ID of the image",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the image",
"example": "7",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[image]",
"required": false,
"schema": {
"items": {
"enum": [
"format",
"hidden",
"id",
"image_url",
"name",
"size",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetImageResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Image",
"tags": [
"Images"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"images:read"
]
},
"patch": {
"description": "Update the image with the given image ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`images:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_image.json)",
"operationId": "update_image",
"parameters": [
{
"description": "The ID of the image",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the image",
"example": "7",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[image]",
"required": false,
"schema": {
"items": {
"enum": [
"format",
"hidden",
"id",
"image_url",
"name",
"size",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ImagePartialUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchImageResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Image",
"tags": [
"Images"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"images:write"
]
}
},
"/api/lists": {
"get": {
"description": "Get all lists in an account.\n\nFilter to request a subset of all lists. Lists can be filtered by `id`, `name`, `created`, and `updated` fields.\n\nReturns a maximum of 10 results per page.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists.json)",
"operationId": "get_lists",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[list]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"name",
"opt_in_process",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`name`: `any`, `equals`
`id`: `any`, `equals`
`created`: `greater-than`
`updated`: `greater-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(name,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"flow-triggers",
"tags"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 10. Min: 1. Max: 10.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 10,
"maximum": 10,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created",
"id",
"-id",
"name",
"-name",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetListListResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Lists",
"tags": [
"Lists"
],
"x-klaviyo-filters": {
"created": {
"operators": {
"single": [
"greater-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"greater-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"lists:read"
]
},
"post": {
"description": "Create a new list.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`
Daily: `150/d`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_list.json)",
"operationId": "create_list",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[list]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"name",
"opt_in_process",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ListCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostListCreateResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create List",
"tags": [
"Lists"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"daily": "150/d",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"lists:write"
]
}
},
"/api/lists/{id}": {
"delete": {
"description": "Delete a list with the given list ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_list.json)",
"operationId": "delete_list",
"parameters": [
{
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete List",
"tags": [
"Lists"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"lists:write"
]
},
"get": {
"description": "Get a list with the given list ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`
Rate limits when using the `additional-fields[list]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`
To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list.json)",
"operationId": "get_list",
"parameters": [
{
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'profile_count'",
"explode": false,
"in": "query",
"name": "additional-fields[list]",
"required": false,
"schema": {
"items": {
"enum": [
"profile_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[list]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"name",
"opt_in_process",
"profile_count",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"flow-triggers",
"tags"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetListRetrieveResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get List",
"tags": [
"Lists"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"lists:read"
]
},
"patch": {
"description": "Update the name of a list with the given list ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_list.json)",
"operationId": "update_list",
"parameters": [
{
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[list]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"name",
"opt_in_process",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ListPartialUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchListPartialUpdateResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update List",
"tags": [
"Lists"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"lists:write"
]
}
},
"/api/lists/{id}/flow-triggers": {
"get": {
"description": "Get all flows where the given list ID is being used as the trigger.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_list.json)",
"operationId": "get_flows_triggered_by_list",
"parameters": [
{
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Flows Triggered by List",
"tags": [
"Lists"
],
"x-klaviyo-operation-aliases": [
"get_flow_triggers_for_list",
"get_list_flow_triggers"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read",
"lists:read"
]
}
},
"/api/lists/{id}/profiles": {
"get": {
"description": "Get all profiles within a list with the given list ID.\n\nFilter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`
*Rate limits*:
Burst: `75/s`
Steady: `750/m`
Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`
To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_list.json)",
"operationId": "get_profiles_for_list",
"parameters": [
{
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
"explode": false,
"in": "query",
"name": "additional-fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"subscriptions",
"predictive_analytics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`email`: `any`, `equals`
`phone_number`: `any`, `equals`
`push_token`: `any`, `equals`
`_kx`: `equals`
`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(email,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"joined_group_at",
"-joined_group_at"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetListMemberResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profiles for List",
"tags": [
"Lists"
],
"x-klaviyo-filters": {
"_kx": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"email": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"joined_group_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"phone_number": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"push_token": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_list_profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"lists:read",
"profiles:read"
]
}
},
"/api/lists/{id}/relationships/flow-triggers": {
"get": {
"description": "Get the IDs of all flows where the given list is being used as the trigger.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_list.json)",
"operationId": "get_ids_for_flows_triggered_by_list",
"parameters": [
{
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetListFlowTriggersRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get IDs for Flows Triggered by List",
"tags": [
"Lists"
],
"x-klaviyo-operation-aliases": [
"get_flow_trigger_ids_for_list",
"get_list_relationships_flow_triggers"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read",
"lists:read"
]
}
},
"/api/lists/{id}/relationships/profiles": {
"delete": {
"description": "Remove a profile from a list with the given list ID.\n\nThe provided profile will no longer receive marketing from this particular list once removed.\n\nRemoving a profile from a list will not impact the profile's [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) status or subscription status in general.\nTo update a profile's subscription status, please use the [Unsubscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/unsubscribe_profiles).\n\nThis endpoint accepts a maximum of 1000 profiles per call.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_profiles_from_list.json)",
"operationId": "remove_profiles_from_list",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ListMembersDeleteQuery"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Remove Profiles from List",
"tags": [
"Lists"
],
"x-klaviyo-operation-aliases": [
"delete_list_relationships",
"delete_list_relationships_profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"lists:write",
"profiles:write"
]
},
"get": {
"description": "Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for a list with the given list ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`
Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`
To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_list.json)",
"operationId": "get_profile_ids_for_list",
"parameters": [
{
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`email`: `any`, `equals`
`phone_number`: `any`, `equals`
`push_token`: `any`, `equals`
`_kx`: `equals`
`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(email,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"joined_group_at",
"-joined_group_at"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetListProfilesRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profile IDs for List",
"tags": [
"Lists"
],
"x-klaviyo-filters": {
"_kx": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"email": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"joined_group_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"phone_number": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"push_token": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_list_relationships_profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"lists:read",
"profiles:read"
]
},
"post": {
"description": "Add a profile to a list with the given list ID.\n\nIt is recommended that you use the [Subscribe Profiles endpoint](https://developers.klaviyo.com/en/reference/subscribe_profiles) if you're trying to give a profile [consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api) to receive email marketing, SMS marketing, or both.\n\nThis endpoint accepts a maximum of 1000 profiles per call.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/add_profiles_to_list.json)",
"operationId": "add_profiles_to_list",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ListMembersAddQuery"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Add Profiles to List",
"tags": [
"Lists"
],
"x-klaviyo-operation-aliases": [
"create_list_relationships",
"create_list_relationships_profile",
"create_list_relationships_profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"lists:write",
"profiles:write"
]
}
},
"/api/lists/{id}/relationships/tags": {
"get": {
"description": "Return all tags associated with the given list ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_list.json)",
"operationId": "get_tag_ids_for_list",
"parameters": [
{
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetListTagsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tag IDs for List",
"tags": [
"Lists"
],
"x-klaviyo-operation-aliases": [
"get_list_relationships_tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"lists:read",
"tags:read"
]
}
},
"/api/lists/{id}/tags": {
"get": {
"description": "Return all tags associated with the given list ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_list.json)",
"operationId": "get_tags_for_list",
"parameters": [
{
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this list. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tags for List",
"tags": [
"Lists"
],
"x-klaviyo-operation-aliases": [
"get_list_tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"lists:read",
"tags:read"
]
}
},
"/api/mapped-metrics": {
"get": {
"description": "Get all mapped metrics in an account.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metrics.json)",
"operationId": "get_mapped_metrics",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[custom-metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.aggregation_method",
"definition.metric_groups",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[mapped-metric]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"custom-metric",
"metric"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMappedMetricResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Mapped Metrics",
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
],
"x-klaviyo-subtag": "Mapped Metrics"
}
},
"/api/mapped-metrics/{id}": {
"get": {
"description": "Get the mapped metric with the given ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_mapped_metric.json)",
"operationId": "get_mapped_metric",
"parameters": [
{
"description": "The type of mapping.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The type of mapping.",
"enum": [
"added_to_cart",
"cancelled_sales",
"ordered_product",
"refunded_sales",
"revenue",
"started_checkout",
"viewed_product"
],
"example": "revenue",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[custom-metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.aggregation_method",
"definition.metric_groups",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[mapped-metric]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"custom-metric",
"metric"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMappedMetricResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Mapped Metric",
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
],
"x-klaviyo-subtag": "Mapped Metrics"
},
"patch": {
"description": "Update the mapped metric with the given ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`
Daily: `30/d`\n\n**Scopes:**\n`metrics:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_mapped_metric.json)",
"operationId": "update_mapped_metric",
"parameters": [
{
"description": "The type of mapping.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The type of mapping.",
"enum": [
"added_to_cart",
"cancelled_sales",
"ordered_product",
"refunded_sales",
"revenue",
"started_checkout",
"viewed_product"
],
"example": "revenue",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[mapped-metric]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/MappedMetricPartialUpdateQuery"
}
}
},
"description": "Update a mapped metric by ID",
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchMappedMetricResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Mapped Metric",
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "30/d",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"metrics:write"
],
"x-klaviyo-subtag": "Mapped Metrics"
}
},
"/api/mapped-metrics/{id}/custom-metric": {
"get": {
"description": "Get the custom metric for the given mapped metric ID (if applicable).
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric_for_mapped_metric.json)",
"operationId": "get_custom_metric_for_mapped_metric",
"parameters": [
{
"description": "The type of mapping.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The type of mapping.",
"enum": [
"added_to_cart",
"cancelled_sales",
"ordered_product",
"refunded_sales",
"revenue",
"started_checkout",
"viewed_product"
],
"example": "revenue",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[custom-metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.aggregation_method",
"definition.metric_groups",
"id",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetCustomMetricResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Custom Metric for Mapped Metric",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_mapped_metric_custom_metric"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
],
"x-klaviyo-subtag": "Mapped Metrics"
}
},
"/api/mapped-metrics/{id}/metric": {
"get": {
"description": "Get the metric for the given mapped metric ID (if applicable).
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_mapped_metric.json)",
"operationId": "get_metric_for_mapped_metric",
"parameters": [
{
"description": "The type of mapping.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The type of mapping.",
"enum": [
"added_to_cart",
"cancelled_sales",
"ordered_product",
"refunded_sales",
"revenue",
"started_checkout",
"viewed_product"
],
"example": "revenue",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metric for Mapped Metric",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_mapped_metric_metric"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
],
"x-klaviyo-subtag": "Mapped Metrics"
}
},
"/api/mapped-metrics/{id}/relationships/custom-metric": {
"get": {
"description": "Get the ID of the custom metric for the given mapped metric.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_custom_metric_id_for_mapped_metric.json)",
"operationId": "get_custom_metric_id_for_mapped_metric",
"parameters": [
{
"description": "The type of mapping.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The type of mapping.",
"enum": [
"added_to_cart",
"cancelled_sales",
"ordered_product",
"refunded_sales",
"revenue",
"started_checkout",
"viewed_product"
],
"example": "revenue",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMappedMetricCustomMetricRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Custom Metric ID for Mapped Metric",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_mapped_metric_relationships_custom_metric"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
],
"x-klaviyo-subtag": "Mapped Metrics"
}
},
"/api/mapped-metrics/{id}/relationships/metric": {
"get": {
"description": "Get the ID of the metric for the given mapped metric.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_mapped_metric.json)",
"operationId": "get_metric_id_for_mapped_metric",
"parameters": [
{
"description": "The type of mapping.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The type of mapping.",
"enum": [
"added_to_cart",
"cancelled_sales",
"ordered_product",
"refunded_sales",
"revenue",
"started_checkout",
"viewed_product"
],
"example": "revenue",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMappedMetricMetricRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metric ID for Mapped Metric",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_mapped_metric_relationships_metric"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
],
"x-klaviyo-subtag": "Mapped Metrics"
}
},
"/api/metric-aggregates": {
"post": {
"description": "Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific metrics, and custom events (not to be confused with [custom metrics](https://developers.klaviyo.com/en/reference/custom_metrics_api_overview), which are not supported at this time). Queries must be passed in the JSON body of your `POST` request.\n\nTo request campaign and flow performance data that matches the data shown in Klaviyo's UI, we recommend the [Reporting API](https://developers.klaviyo.com/en/reference/reporting_api_overview).\n\nResults can be filtered and grouped by time, event, or profile dimensions.\n\nTo learn more about how to use this endpoint, check out our new [Using the Query Metric Aggregates Endpoint guide](https://developers.klaviyo.com/en/docs/using-the-query-metric-aggregates-endpoint).\n\nFor a comprehensive list of request body parameters, native Klaviyo metrics, and their associated attributes for grouping and filtering, please refer to the [metrics attributes guide](https://developers.klaviyo.com/en/docs/supported_metrics_and_attributes).
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_metric_aggregates.json)",
"operationId": "query_metric_aggregates",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric-aggregate]",
"required": false,
"schema": {
"items": {
"enum": [
"data",
"dates",
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/MetricAggregateQuery"
}
}
},
"description": "Retrieve Metric Aggregations",
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostMetricAggregateResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Query Metric Aggregates",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"create_metric_aggregate"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"metrics:read"
]
}
},
"/api/metric-properties/{id}": {
"get": {
"description": "Get a metric property with the given metric property ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_property.json)",
"operationId": "get_metric_property",
"parameters": [
{
"description": "The ID of the metric property",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the metric property",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'sample_values'",
"explode": false,
"in": "query",
"name": "additional-fields[metric-property]",
"required": false,
"schema": {
"items": {
"enum": [
"sample_values"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric-property]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"inferred_type",
"label",
"property",
"sample_values"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"metric"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricPropertyResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metric Property",
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"metrics:read"
]
}
},
"/api/metric-properties/{id}/metric": {
"get": {
"description": "Get the metric for the given metric property ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_for_metric_property.json)",
"operationId": "get_metric_for_metric_property",
"parameters": [
{
"description": "The ID of the metric property",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the metric property",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metric for Metric Property",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_metric_property_metric"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"metrics:read"
]
}
},
"/api/metric-properties/{id}/relationships/metric": {
"get": {
"description": "Get the ID of the metric for the given metric property.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric_id_for_metric_property.json)",
"operationId": "get_metric_id_for_metric_property",
"parameters": [
{
"description": "The ID of the metric property",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the metric property",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricPropertyMetricRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metric ID for Metric Property",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_metric_property_relationships_metric"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"metrics:read"
]
}
},
"/api/metrics": {
"get": {
"description": "Get all metrics in an account.\n\nRequests can be filtered by the following fields:\nintegration `name`, integration `category`\n\nReturns a maximum of 200 results per page.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metrics.json)",
"operationId": "get_metrics",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`integration.name`: `equals`
`integration.category`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(integration.name,'example')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"flow-triggers"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metrics",
"tags": [
"Metrics"
],
"x-klaviyo-filters": {
"integration.category": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"integration.name": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"metrics:read"
]
}
},
"/api/metrics/{id}": {
"get": {
"description": "Get a metric with the given metric ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_metric.json)",
"operationId": "get_metric",
"parameters": [
{
"description": "Metric ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Metric ID",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"integration",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"flow-triggers"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Metric",
"tags": [
"Metrics"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"metrics:read"
]
}
},
"/api/metrics/{id}/flow-triggers": {
"get": {
"description": "Get all flows where the given metric is being used as the trigger.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`flows:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_metric.json)",
"operationId": "get_flows_triggered_by_metric",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Flows Triggered by Metric",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_flow_triggers_for_metric",
"get_metric_flow_triggers"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"flows:read",
"metrics:read"
]
}
},
"/api/metrics/{id}/metric-properties": {
"get": {
"description": "Get the metric properties for the given metric ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_properties_for_metric.json)",
"operationId": "get_properties_for_metric",
"parameters": [
{
"description": "The ID of the metric",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the metric",
"example": "925e38",
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'sample_values'",
"explode": false,
"in": "query",
"name": "additional-fields[metric-property]",
"required": false,
"schema": {
"items": {
"enum": [
"sample_values"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[metric-property]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"inferred_type",
"label",
"property",
"sample_values"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricPropertyResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Properties for Metric",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_metric_metric_properties",
"get_metric_properties"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"metrics:read"
]
}
},
"/api/metrics/{id}/relationships/flow-triggers": {
"get": {
"description": "Get the IDs of all flows where the given metric is being used as the trigger.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`flows:read`\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_metric.json)",
"operationId": "get_ids_for_flows_triggered_by_metric",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricFlowTriggersRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get IDs for Flows Triggered by Metric",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_flow_trigger_ids_for_metric",
"get_metric_relationships_flow_triggers"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"flows:read",
"metrics:read"
]
}
},
"/api/metrics/{id}/relationships/metric-properties": {
"get": {
"description": "Get the IDs of metric properties for the given metric.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`metrics:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_property_ids_for_metric.json)",
"operationId": "get_property_ids_for_metric",
"parameters": [
{
"description": "The ID of the metric",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the metric",
"example": "925e38",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetMetricPropertiesRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Property IDs for Metric",
"tags": [
"Metrics"
],
"x-klaviyo-operation-aliases": [
"get_metric_relationships_metric_properties",
"get_metric_relationships_properties"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"metrics:read"
]
}
},
"/api/profile-bulk-import-jobs": {
"get": {
"description": "Get all bulk profile import jobs.\n\nReturns a maximum of 100 jobs per request.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_jobs.json)",
"operationId": "get_bulk_import_profiles_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile-bulk-import-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"expires_at",
"failed_count",
"id",
"started_at",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `any`, `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'queued')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created_at",
"-created_at"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileImportJobResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Import Profiles Jobs",
"tags": [
"Profiles"
],
"x-klaviyo-filters": {
"status": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_bulk_profile_import_jobs",
"get_profile_bulk_import_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"lists:read",
"profiles:read"
],
"x-klaviyo-subtag": "Bulk Import Profiles"
},
"post": {
"description": "Create a bulk profile import job to create or update a batch of profiles.\n\nAccepts up to 10,000 profiles per request. The maximum allowed payload size is 5MB. The maximum allowed payload size per-profile is 100KB.\n\nTo learn more, see our [Bulk Profile Import API guide](https://developers.klaviyo.com/en/docs/use_klaviyos_bulk_profile_import_api).
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_import_profiles.json)",
"operationId": "bulk_import_profiles",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile-bulk-import-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"expires_at",
"failed_count",
"id",
"started_at",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ProfileImportJobCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostProfileImportJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Import Profiles",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"spawn_bulk_profile_import_job",
"create_profile_bulk_import_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"lists:write",
"profiles:write"
],
"x-klaviyo-subtag": "Bulk Import Profiles"
}
},
"/api/profile-bulk-import-jobs/{id}/import-errors": {
"get": {
"description": "Get import errors for the bulk profile import job with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_errors_for_bulk_import_profiles_job.json)",
"operationId": "get_errors_for_bulk_import_profiles_job",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[import-error]",
"required": false,
"schema": {
"items": {
"enum": [
"code",
"detail",
"id",
"original_payload",
"source",
"source.pointer",
"title"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetImportErrorResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Errors for Bulk Import Profiles Job",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_bulk_profile_import_job_import_errors",
"get_import_errors_for_profile_bulk_import_job",
"get_profile_bulk_import_job_import_errors"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"profiles:read"
],
"x-klaviyo-subtag": "Bulk Import Profiles"
}
},
"/api/profile-bulk-import-jobs/{id}/lists": {
"get": {
"description": "Get list for the bulk profile import job with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_for_bulk_import_profiles_job.json)",
"operationId": "get_list_for_bulk_import_profiles_job",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[list]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"name",
"opt_in_process",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetListResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get List for Bulk Import Profiles Job",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_bulk_profile_import_job_lists",
"get_lists_for_profile_bulk_import_job",
"get_profile_bulk_import_job_lists"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"lists:read"
],
"x-klaviyo-subtag": "Bulk Import Profiles"
}
},
"/api/profile-bulk-import-jobs/{id}/profiles": {
"get": {
"description": "Get profiles for the bulk profile import job with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_bulk_import_profiles_job.json)",
"operationId": "get_profiles_for_bulk_import_profiles_job",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
"explode": false,
"in": "query",
"name": "additional-fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"subscriptions",
"predictive_analytics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profiles for Bulk Import Profiles Job",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_bulk_profile_import_job_profiles",
"get_profile_bulk_import_job_profiles",
"get_profiles_for_profile_bulk_import_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"profiles:read"
],
"x-klaviyo-subtag": "Bulk Import Profiles"
}
},
"/api/profile-bulk-import-jobs/{id}/relationships/lists": {
"get": {
"description": "Get list relationship for the bulk profile import job with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_bulk_import_profiles_job.json)",
"operationId": "get_list_ids_for_bulk_import_profiles_job",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileBulkImportJobListsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get List IDs for Bulk Import Profiles Job",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_bulk_profile_import_job_relationships_lists",
"get_list_ids_for_profile_bulk_import_job",
"get_profile_bulk_import_job_relationships_lists"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"lists:read"
],
"x-klaviyo-subtag": "Bulk Import Profiles"
}
},
"/api/profile-bulk-import-jobs/{id}/relationships/profiles": {
"get": {
"description": "Get profile relationships for the bulk profile import job with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_bulk_import_profiles_job.json)",
"operationId": "get_profile_ids_for_bulk_import_profiles_job",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileBulkImportJobProfilesRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profile IDs for Bulk Import Profiles Job",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_bulk_profile_import_job_relationships_profiles",
"get_profile_bulk_import_job_relationships_profiles",
"get_profile_ids_for_profile_bulk_import_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"profiles:read"
],
"x-klaviyo-subtag": "Bulk Import Profiles"
}
},
"/api/profile-bulk-import-jobs/{job_id}": {
"get": {
"description": "Get a bulk profile import job with the given job ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_import_profiles_job.json)",
"operationId": "get_bulk_import_profiles_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[list]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"name",
"opt_in_process",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile-bulk-import-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"expires_at",
"failed_count",
"id",
"started_at",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"lists"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileImportJobResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Import Profiles Job",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_bulk_profile_import_job",
"get_profile_bulk_import_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"lists:read",
"profiles:read"
],
"x-klaviyo-subtag": "Bulk Import Profiles"
}
},
"/api/profile-import": {
"post": {
"description": "Given a set of profile attributes and optionally an ID, create or update a profile.\n\nReturns 201 if a new profile was created, 200 if an existing profile was updated.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nNote that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.\n\nThe maximum allowed payload size is 100KB.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_or_update_profile.json)",
"operationId": "create_or_update_profile",
"parameters": [
{
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
"explode": false,
"in": "query",
"name": "additional-fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"subscriptions",
"predictive_analytics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ProfileUpsertQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostProfileResponse"
}
}
},
"description": "Profile Updated Successfully"
},
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostProfileResponse"
}
}
},
"description": "Profile Created Successfully"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create or Update Profile",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"create_profile_import"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"profiles:write"
]
}
},
"/api/profile-merge": {
"post": {
"description": "Merge a given related profile into a profile with the given profile ID.\n\nThe profile provided under `relationships` (the \"source\" profile) will be merged into the profile provided by the ID in the base data object (the \"destination\" profile).\nThis endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile.\n\nTo learn more about how profile data is preserved or overwritten during a merge, please [visit our Help Center](https://help.klaviyo.com/hc/en-us/articles/115005073847#merge-2-profiles3).
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/merge_profiles.json)",
"operationId": "merge_profiles",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ProfileMergeQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostProfileMergeResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Merge Profiles",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"create_profile_merge"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"profiles:write"
]
}
},
"/api/profile-subscription-bulk-create-jobs": {
"post": {
"description": "Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double opt-in enabled, profiles will receive a message requiring their confirmation before subscribing. Otherwise, profiles will be immediately subscribed without receiving a confirmation message.\nLearn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nIf a list is not provided, the opt-in process used will be determined by the [account-level default opt-in setting](https://www.klaviyo.com/settings/account/api-keys).\n\nTo add someone to a list without changing their subscription status, use [Add Profile to List](https://developers.klaviyo.com/en/reference/create_list_relationships).\n\nThis API will remove any `UNSUBSCRIBE`, `SPAM_REPORT` or `USER_SUPPRESSED` suppressions from the provided profiles. Learn more about [suppressed profiles](https://help.klaviyo.com/hc/en-us/articles/115005246108-Understanding-suppressed-email-profiles#what-is-a-suppressed-profile-1).\n\nMaximum number of profiles can be submitted for subscription: 1000\n\nThis endpoint now supports a `historical_import` flag. If this flag is set `true`, profiles being subscribed will bypass double opt-in emails and be subscribed immediately. They will also bypass any associated \"Added to list\" flows. This is useful for importing historical data where you have already collected consent. If `historical_import` is set to true, the `consented_at` field is required and must be in the past.\n\nPush tokens provided in `push_tokens` will be registered for each profile as long as push subscriptions are consented to.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_subscribe_profiles.json)",
"operationId": "bulk_subscribe_profiles",
"parameters": [
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionCreateJobCreateQuery"
}
}
},
"description": "Subscribes one or more profiles to marketing, with support for push channel and push tokens.\nAll profiles will be added to the provided list. Either email or phone number is required.\nBoth may be specified to subscribe to both channels. If a profile cannot be found matching\nthe given identifier(s), a new profile will be created and then subscribed.",
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Subscribe Profiles",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"subscribe_profiles",
"create_profile_subscription_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"lists:write",
"profiles:write",
"subscriptions:write"
],
"x-klaviyo-subtag": "Consent"
}
},
"/api/profile-subscription-bulk-delete-jobs": {
"post": {
"description": "> \ud83d\udea7\n>\n> Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes.\n\nUnsubscribe one or more profiles from email marketing, SMS marketing, push marketing, or a combination. Learn more about [consent in this guide](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nPush tokens provided in `subscriptions.push.tokens` will be removed for the specified profiles.\n\nTo remove someone from a list without changing their subscription status, use [Remove Profiles from List](https://developers.klaviyo.com/en/reference/remove_profiles_from_list).\n\nMaximum number of profiles per call: 100
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`lists:write`\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsubscribe_profiles.json)",
"operationId": "bulk_unsubscribe_profiles",
"parameters": [
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionDeleteJobCreateQuery"
}
}
},
"description": "Unsubscribes one or more profiles from marketing. Supports email, SMS, WhatsApp, and push channels. All profiles will be removed from the provided list.\nEither email or phone number is required for email/SMS/WhatsApp channels. Push tokens can be removed by providing token strings directly.\nIf a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.",
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Unsubscribe Profiles",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"unsubscribe_profiles",
"create_profile_subscription_bulk_delete_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"lists:write",
"profiles:write",
"subscriptions:write"
],
"x-klaviyo-subtag": "Consent"
}
},
"/api/profile-suppression-bulk-create-jobs": {
"get": {
"description": "Get the status of all bulk profile suppression jobs.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_jobs.json)",
"operationId": "get_bulk_suppress_profiles_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile-suppression-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"id",
"skipped_count",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`list_id`: `equals`
`segment_id`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetBulkProfileSuppressionsCreateJobResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Suppress Profiles Jobs",
"tags": [
"Profiles"
],
"x-klaviyo-filters": {
"list_id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"segment_id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_profile_suppression_bulk_create_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"subscriptions:read"
],
"x-klaviyo-subtag": "Consent"
},
"post": {
"description": "Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list.\n\nSuppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nEmail address per request limit: 100
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_suppress_profiles.json)",
"operationId": "bulk_suppress_profiles",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile-suppression-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"id",
"skipped_count",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SuppressionCreateJobCreateQuery"
}
}
},
"description": "Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.",
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostBulkProfileSuppressionsCreateJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Suppress Profiles",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"suppress_profiles",
"create_profile_suppression_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"profiles:write",
"subscriptions:write"
],
"x-klaviyo-subtag": "Consent"
}
},
"/api/profile-suppression-bulk-create-jobs/{job_id}": {
"get": {
"description": "Get the bulk suppress profiles job with the given job ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_suppress_profiles_job.json)",
"operationId": "get_bulk_suppress_profiles_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile-suppression-bulk-create-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"id",
"skipped_count",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetBulkProfileSuppressionsCreateJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Suppress Profiles Job",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_profile_suppression_bulk_create_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"subscriptions:read"
],
"x-klaviyo-subtag": "Consent"
}
},
"/api/profile-suppression-bulk-delete-jobs": {
"get": {
"description": "Get all bulk unsuppress profiles jobs.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_jobs.json)",
"operationId": "get_bulk_unsuppress_profiles_jobs",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile-suppression-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"id",
"skipped_count",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`list_id`: `equals`
`segment_id`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'processing')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetBulkProfileSuppressionsRemoveJobResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Unsuppress Profiles Jobs",
"tags": [
"Profiles"
],
"x-klaviyo-filters": {
"list_id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"segment_id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"queued",
"processing",
"complete",
"cancelled"
],
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_profile_suppression_bulk_delete_jobs"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"subscriptions:read"
],
"x-klaviyo-subtag": "Consent"
},
"post": {
"description": "Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a segment/list.\n\nThis only removes suppressions with reason USER_SUPPRESSED ; unsubscribed profiles and suppressed profiles with reason INVALID_EMAIL or HARD_BOUNCE remain unchanged. To learn more, see our guides on [email suppressions](https://help.klaviyo.com/hc/en-us/articles/115005246108#what-is-a-suppressed-profile-1) and [collecting consent](https://developers.klaviyo.com/en/docs/collect_email_and_sms_consent_via_api).\n\nEmail address per request limit: 100
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_unsuppress_profiles.json)",
"operationId": "bulk_unsuppress_profiles",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile-suppression-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"id",
"skipped_count",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SuppressionDeleteJobCreateQuery"
}
}
},
"description": "Unsuppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not\nfound with the given email, no action will be taken.",
"required": true
},
"responses": {
"202": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostBulkProfileSuppressionsRemoveJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Bulk Unsuppress Profiles",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"unsuppress_profiles",
"create_profile_suppression_bulk_delete_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"subscriptions:write"
],
"x-klaviyo-subtag": "Consent"
}
},
"/api/profile-suppression-bulk-delete-jobs/{job_id}": {
"get": {
"description": "Get the bulk unsuppress profiles job with the given job ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_bulk_unsuppress_profiles_job.json)",
"operationId": "get_bulk_unsuppress_profiles_job",
"parameters": [
{
"description": "ID of the job to retrieve.",
"in": "path",
"name": "job_id",
"required": true,
"schema": {
"description": "ID of the job to retrieve.",
"example": "01GSQPBF74KQ5YTDEPP41T1BZH",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile-suppression-bulk-delete-job]",
"required": false,
"schema": {
"items": {
"enum": [
"completed_at",
"completed_count",
"created_at",
"id",
"skipped_count",
"status",
"total_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetBulkProfileSuppressionsRemoveJobResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Bulk Unsuppress Profiles Job",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_profile_suppression_bulk_delete_job"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"subscriptions:read"
],
"x-klaviyo-subtag": "Consent"
}
},
"/api/profiles": {
"get": {
"description": "Get all profiles in an account.\n\nProfiles can be sorted by the following fields in ascending and descending order: `id`, `created`, `updated`, `email`, `subscriptions.email.marketing.suppression.timestamp`, `subscriptions.email.marketing.list_suppressions.timestamp`\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`
Rate limits when using the `additional-fields[profile]=predictive_analytics` parameter in your API request:
Burst: `10/s`
Steady: `150/m`
To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles.json)",
"operationId": "get_profiles",
"parameters": [
{
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
"explode": false,
"in": "query",
"name": "additional-fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"subscriptions",
"predictive_analytics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[conversation]",
"required": false,
"schema": {
"items": {
"enum": [
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[push-token]",
"required": false,
"schema": {
"items": {
"enum": [
"background",
"created",
"enablement_status",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`, `equals`
`email`: `any`, `equals`
`phone_number`: `any`, `equals`
`external_id`: `any`, `equals`
`_kx`: `equals`
`created`: `greater-than`, `less-than`
`updated`: `greater-than`, `less-than`
`subscriptions.email.marketing.list_suppressions.reason`: `equals`
`subscriptions.email.marketing.list_suppressions.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`subscriptions.email.marketing.list_suppressions.list_id`: `equals`
`subscriptions.email.marketing.suppression.reason`: `equals`
`subscriptions.email.marketing.suppression.timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(id,'example')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"conversation",
"push-tokens"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"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"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profiles",
"tags": [
"Profiles"
],
"x-klaviyo-filters": {
"_kx": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"created": {
"operators": {
"single": [
"greater-than",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"email": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"external_id": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"phone_number": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"subscriptions.email.marketing.list_suppressions.list_id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"subscriptions.email.marketing.list_suppressions.reason": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"subscriptions.email.marketing.list_suppressions.timestamp": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"subscriptions.email.marketing.suppression.reason": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"subscriptions.email.marketing.suppression.timestamp": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"greater-than",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"profiles:read"
]
},
"post": {
"description": "Create a new profile.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nThe maximum allowed payload size is 100KB.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_profile.json)",
"operationId": "create_profile",
"parameters": [
{
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
"explode": false,
"in": "query",
"name": "additional-fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"subscriptions",
"predictive_analytics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ProfileCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostProfileResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Profile",
"tags": [
"Profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"profiles:write"
]
}
},
"/api/profiles/{id}": {
"get": {
"description": "Get the profile with the given profile ID.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`
Rate limits when using the `include=list` parameter in your API request:
Burst: `1/s`
Steady: `15/m`
Rate limits when using the `include=segment` parameter in your API request:
Burst: `1/s`
Steady: `15/m`
To learn more about how the `include` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile.json)",
"operationId": "get_profile",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
"explode": false,
"in": "query",
"name": "additional-fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"subscriptions",
"predictive_analytics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[conversation]",
"required": false,
"schema": {
"items": {
"enum": [
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[list]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"name",
"opt_in_process",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[push-token]",
"required": false,
"schema": {
"items": {
"enum": [
"background",
"created",
"enablement_status",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[segment]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.condition_groups",
"id",
"is_active",
"is_processing",
"is_starred",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"conversation",
"lists",
"push-tokens",
"segments"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profile",
"tags": [
"Profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"profiles:read"
]
},
"patch": {
"description": "Update the profile with the given profile ID.\n\nUse the `additional-fields` parameter to include subscriptions and predictive analytics data in your response.\n\nNote that setting a field to `null` will clear out the field, whereas not including a field in your request will leave it unchanged.\n\nThe maximum allowed payload size is 100KB.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_profile.json)",
"operationId": "update_profile",
"parameters": [
{
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this profile. Generated by Klaviyo.",
"example": "01GDDKASAP8TKDDA2GRZDSVP4H",
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
"explode": false,
"in": "query",
"name": "additional-fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"subscriptions",
"predictive_analytics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ProfilePartialUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchProfileResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Profile",
"tags": [
"Profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"profiles:write"
]
}
},
"/api/profiles/{id}/conversation": {
"get": {
"description": "Get the conversation for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_for_profile.json)",
"operationId": "get_conversation_for_profile",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[conversation]",
"required": false,
"schema": {
"items": {
"enum": [
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetConversationResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Conversation for Profile",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_profile_conversation"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"conversations:read",
"profiles:read"
],
"x-klaviyo-subtag": "Conversations"
}
},
"/api/profiles/{id}/lists": {
"get": {
"description": "Get list memberships for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_lists_for_profile.json)",
"operationId": "get_lists_for_profile",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[list]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"id",
"name",
"opt_in_process",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetListResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Lists for Profile",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_profile_lists"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"lists:read",
"profiles:read"
]
}
},
"/api/profiles/{id}/push-tokens": {
"get": {
"description": "Return all push tokens that belong to the given profile.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens_for_profile.json)",
"operationId": "get_push_tokens_for_profile",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[push-token]",
"required": false,
"schema": {
"items": {
"enum": [
"background",
"created",
"enablement_status",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetPushTokenResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Push Tokens for Profile",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_profile_push_tokens"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"profiles:read"
]
}
},
"/api/profiles/{id}/relationships/conversation": {
"get": {
"description": "Get the conversation relationship for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`conversations:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_conversation_id_for_profile.json)",
"operationId": "get_conversation_id_for_profile",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileConversationRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Conversation ID for Profile",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_profile_relationships_conversation"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"conversations:read",
"profiles:read"
],
"x-klaviyo-subtag": "Conversations"
}
},
"/api/profiles/{id}/relationships/lists": {
"get": {
"description": "Get list memberships for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_profile.json)",
"operationId": "get_list_ids_for_profile",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileListsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get List IDs for Profile",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_profile_relationships_lists"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"lists:read",
"profiles:read"
]
}
},
"/api/profiles/{id}/relationships/push-tokens": {
"get": {
"description": "Return the IDs of all push tokens associated with the given profile.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token_ids_for_profile.json)",
"operationId": "get_push_token_ids_for_profile",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfilePushTokensRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Push Token IDs for Profile",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_profile_relationships_push_tokens"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"profiles:read"
]
}
},
"/api/profiles/{id}/relationships/segments": {
"get": {
"description": "Get segment membership relationships for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_profile.json)",
"operationId": "get_segment_ids_for_profile",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileSegmentsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Segment IDs for Profile",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_profile_relationships_segments"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"profiles:read",
"segments:read"
]
}
},
"/api/profiles/{id}/segments": {
"get": {
"description": "Get segment memberships for a profile with the given profile ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments_for_profile.json)",
"operationId": "get_segments_for_profile",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[segment]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.condition_groups",
"id",
"is_active",
"is_processing",
"is_starred",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetSegmentResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Segments for Profile",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_profile_segments"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"profiles:read",
"segments:read"
]
}
},
"/api/push-tokens": {
"get": {
"description": "Return push tokens associated with company.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_tokens.json)",
"operationId": "get_push_tokens",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[push-token]",
"required": false,
"schema": {
"items": {
"enum": [
"background",
"created",
"enablement_status",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `equals`
`profile.id`: `equals`
`enablement_status`: `equals`
`platform`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(id,'example')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"profile"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetPushTokenResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Push Tokens",
"tags": [
"Profiles"
],
"x-klaviyo-filters": {
"enablement_status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"AUTHORIZED",
"UNAUTHORIZED",
"DENIED",
"PROVISIONAL",
"NOT_DETERMINED"
],
"type": "string"
}
},
"id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"platform": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"ios",
"android"
],
"type": "string"
}
},
"profile.id": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"profiles:read",
"push-tokens:read"
],
"x-klaviyo-subtag": "Push Tokens"
},
"post": {
"description": "Create or update a push token.\n\nThis endpoint can be used to migrate push tokens from another platform to Klaviyo. Please use our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) to create push tokens from users' devices.\n\nThe maximum allowed payload size is 100KB.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`profiles:write`\n`push-tokens:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_push_token.json)",
"operationId": "create_push_token",
"parameters": [
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PushTokenCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create or Update Push Token",
"tags": [
"Profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"profiles:write",
"push-tokens:write"
],
"x-klaviyo-subtag": "Push Tokens"
}
},
"/api/push-tokens/{id}": {
"delete": {
"description": "Delete a specific push token based on its ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`push-tokens:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_push_token.json)",
"operationId": "delete_push_token",
"parameters": [
{
"description": "The value of the push token to delete",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The value of the push token to delete",
"example": "925e385b52fb405715f3616c337cc65c",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Push Token",
"tags": [
"Profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"push-tokens:write"
],
"x-klaviyo-subtag": "Push Tokens"
},
"get": {
"description": "Return a specific push token based on its ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_push_token.json)",
"operationId": "get_push_token",
"parameters": [
{
"description": "The value of the push token",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The value of the push token",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[push-token]",
"required": false,
"schema": {
"items": {
"enum": [
"background",
"created",
"enablement_status",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"profile"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetPushTokenResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Push Token",
"tags": [
"Profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"profiles:read",
"push-tokens:read"
],
"x-klaviyo-subtag": "Push Tokens"
}
},
"/api/push-tokens/{id}/profile": {
"get": {
"description": "Return the profile associated with the given push token.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_for_push_token.json)",
"operationId": "get_profile_for_push_token",
"parameters": [
{
"description": "The value of the push token",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The value of the push token",
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
"explode": false,
"in": "query",
"name": "additional-fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"subscriptions",
"predictive_analytics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetProfileResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profile for Push Token",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_push_token_profile"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"profiles:read",
"push-tokens:read"
],
"x-klaviyo-subtag": "Push Tokens"
}
},
"/api/push-tokens/{id}/relationships/profile": {
"get": {
"description": "Return the ID of the profile associated with the given push token.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`profiles:read`\n`push-tokens:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_id_for_push_token.json)",
"operationId": "get_profile_id_for_push_token",
"parameters": [
{
"description": "The value of the push token",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The value of the push token",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetPushTokenProfileRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profile ID for Push Token",
"tags": [
"Profiles"
],
"x-klaviyo-operation-aliases": [
"get_push_token_relationships_profile"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"profiles:read",
"push-tokens:read"
],
"x-klaviyo-subtag": "Push Tokens"
}
},
"/api/reviews": {
"get": {
"description": "Get all reviews.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`reviews:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_reviews.json)",
"operationId": "get_reviews",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[event]",
"required": false,
"schema": {
"items": {
"enum": [
"datetime",
"event_properties",
"id",
"timestamp",
"uuid"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[review]",
"required": false,
"schema": {
"items": {
"enum": [
"author",
"content",
"created",
"email",
"id",
"images",
"product",
"product.external_id",
"product.image_url",
"product.name",
"product.url",
"public_reply",
"public_reply.author",
"public_reply.content",
"public_reply.updated",
"rating",
"review_type",
"smart_quote",
"status",
"status.rejection_reason",
"status.rejection_reason.reason",
"status.rejection_reason.status_explanation",
"status.value",
"title",
"updated",
"verified"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`created`: `greater-or-equal`, `less-or-equal`
`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`
`id`: `any`, `equals`
`item.id`: `any`, `equals`
`content`: `contains`
`status`: `equals`
`review_type`: `equals`
`verified`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "less-or-equal(created,2022-11-08T00:00:00+00:00)",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"events"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created",
"rating",
"-rating",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetReviewResponseDTOCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Reviews",
"tags": [
"Reviews"
],
"x-klaviyo-filters": {
"content": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
},
"created": {
"operators": {
"single": [
"greater-or-equal",
"less-or-equal"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"item.id": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"rating": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals",
"greater-or-equal",
"less-or-equal"
]
},
"value": {
"type": "integer"
}
},
"review_type": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"question",
"review",
"rating",
"store"
],
"type": "string"
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"published",
"unpublished",
"rejected",
"featured",
"pending",
"all"
],
"type": "string"
}
},
"verified": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"reviews:read"
]
}
},
"/api/reviews/{id}": {
"get": {
"description": "Get the review with the given ID.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`reviews:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_review.json)",
"operationId": "get_review",
"parameters": [
{
"description": "The ID of the review",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the review",
"example": "2134228",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[event]",
"required": false,
"schema": {
"items": {
"enum": [
"datetime",
"event_properties",
"id",
"timestamp",
"uuid"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[review]",
"required": false,
"schema": {
"items": {
"enum": [
"author",
"content",
"created",
"email",
"id",
"images",
"product",
"product.external_id",
"product.image_url",
"product.name",
"product.url",
"public_reply",
"public_reply.author",
"public_reply.content",
"public_reply.updated",
"rating",
"review_type",
"smart_quote",
"status",
"status.rejection_reason",
"status.rejection_reason.reason",
"status.rejection_reason.status_explanation",
"status.value",
"title",
"updated",
"verified"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"events"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetReviewResponseDTOCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Review",
"tags": [
"Reviews"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"reviews:read"
]
},
"patch": {
"description": "Update a review.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`reviews:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_review.json)",
"operationId": "update_review",
"parameters": [
{
"description": "The id of the review (review ID).",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The id of the review (review ID).",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[review]",
"required": false,
"schema": {
"items": {
"enum": [
"author",
"content",
"created",
"email",
"id",
"images",
"product",
"product.external_id",
"product.image_url",
"product.name",
"product.url",
"public_reply",
"public_reply.author",
"public_reply.content",
"public_reply.updated",
"rating",
"review_type",
"smart_quote",
"status",
"status.rejection_reason",
"status.rejection_reason.reason",
"status.rejection_reason.status_explanation",
"status.value",
"title",
"updated",
"verified"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ReviewPatchQuery"
}
}
},
"description": "DTO for updating reviews",
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchReviewResponseDTO"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Review",
"tags": [
"Reviews"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"reviews:write"
]
}
},
"/api/segment-series-reports": {
"post": {
"description": "Returns the requested segment analytics series data.
*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d`\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_series.json)",
"operationId": "query_segment_series",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[segment-series-report]",
"required": false,
"schema": {
"items": {
"enum": [
"date_times",
"id",
"results"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SegmentSeriesRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostSegmentSeriesResponseDTO"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Query Segment Series",
"tags": [
"Reporting"
],
"x-klaviyo-operation-aliases": [
"create_segment_sery_report",
"create_segment_series_report"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "225/d",
"steady": "2/m"
},
"x-klaviyo-scopes": [
"segments:read"
]
}
},
"/api/segment-values-reports": {
"post": {
"description": "Returns the requested segment analytics values data.
*Rate limits*:
Burst: `1/s`
Steady: `2/m`
Daily: `225/d`\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/query_segment_values.json)",
"operationId": "query_segment_values",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[segment-values-report]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"results"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SegmentValuesRequestDTO"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostSegmentValuesResponseDTO"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Query Segment Values",
"tags": [
"Reporting"
],
"x-klaviyo-operation-aliases": [
"create_segment_value_report",
"create_segment_values_report"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "225/d",
"steady": "2/m"
},
"x-klaviyo-scopes": [
"segments:read"
]
}
},
"/api/segments": {
"get": {
"description": "Get all segments in an account.\n\nFilter to request a subset of all segments. Segments can be filtered by `name`, `created`, and `updated` fields.\n\nReturns a maximum of 10 results per page.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segments.json)",
"operationId": "get_segments",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[segment]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.condition_groups",
"id",
"is_active",
"is_processing",
"is_starred",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`name`: `any`, `equals`
`id`: `any`, `equals`
`created`: `greater-than`
`updated`: `greater-than`
`is_active`: `any`, `equals`
`is_starred`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(name,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"flow-triggers",
"tags"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 10. Min: 1. Max: 10.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 10,
"maximum": 10,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created",
"id",
"-id",
"name",
"-name",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetSegmentListResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Segments",
"tags": [
"Segments"
],
"x-klaviyo-filters": {
"created": {
"operators": {
"single": [
"greater-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"is_active": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"is_starred": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"name": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"greater-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"segments:read"
]
},
"post": {
"description": "Create a segment.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`
Daily: `100/d`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_segment.json)",
"operationId": "create_segment",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[segment]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.condition_groups",
"id",
"is_active",
"is_processing",
"is_starred",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SegmentCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostSegmentCreateResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Segment",
"tags": [
"Segments"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "100/d",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"segments:write"
]
}
},
"/api/segments/{id}": {
"delete": {
"description": "Delete a segment with the given segment ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_segment.json)",
"operationId": "delete_segment",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Segment",
"tags": [
"Segments"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"segments:write"
]
},
"get": {
"description": "Get a segment with the given segment ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`
Rate limits when using the `additional-fields[segment]=profile_count` parameter in your API request:
Burst: `1/s`
Steady: `15/m`
To learn more about how the `additional-fields` parameter impacts rate limits, check out our [Rate limits, status codes, and errors](https://developers.klaviyo.com/en/v2026-04-15/docs/rate_limits_and_error_handling) guide.\n\n**Scopes:**\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment.json)",
"operationId": "get_segment",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'profile_count'",
"explode": false,
"in": "query",
"name": "additional-fields[segment]",
"required": false,
"schema": {
"items": {
"enum": [
"profile_count"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[segment]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.condition_groups",
"id",
"is_active",
"is_processing",
"is_starred",
"name",
"profile_count",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"flow-triggers",
"tags"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetSegmentRetrieveResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Segment",
"tags": [
"Segments"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"segments:read"
]
},
"patch": {
"description": "Update a segment with the given segment ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`
Daily: `100/d`\n\n**Scopes:**\n`segments:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_segment.json)",
"operationId": "update_segment",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[segment]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.condition_groups",
"id",
"is_active",
"is_processing",
"is_starred",
"name",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/SegmentPartialUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchSegmentPartialUpdateResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Segment",
"tags": [
"Segments"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"daily": "100/d",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"segments:write"
]
}
},
"/api/segments/{id}/flow-triggers": {
"get": {
"description": "Get all flows where the given segment ID is being used as the trigger.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flows_triggered_by_segment.json)",
"operationId": "get_flows_triggered_by_segment",
"parameters": [
{
"description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[flow]",
"required": false,
"schema": {
"items": {
"enum": [
"archived",
"created",
"id",
"name",
"status",
"trigger_type",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetFlowResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Flows Triggered by Segment",
"tags": [
"Segments"
],
"x-klaviyo-operation-aliases": [
"get_flow_triggers_for_segment",
"get_segment_flow_triggers"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read",
"segments:read"
]
}
},
"/api/segments/{id}/profiles": {
"get": {
"description": "Get all profiles within a segment with the given segment ID.\n\nFilter to request a subset of all profiles. Profiles can be filtered by `email`, `phone_number`, `push_token`, and `joined_group_at` fields. Profiles can be sorted by the following fields, in ascending and descending order: `joined_group_at`
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profiles_for_segment.json)",
"operationId": "get_profiles_for_segment",
"parameters": [
{
"description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'subscriptions', 'predictive_analytics'",
"explode": false,
"in": "query",
"name": "additional-fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"subscriptions",
"predictive_analytics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[profile]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"email",
"external_id",
"first_name",
"id",
"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"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`profile_id`: `any`, `equals`
`email`: `any`, `equals`
`phone_number`: `any`, `equals`
`push_token`: `any`, `equals`
`_kx`: `equals`
`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(profile_id,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"joined_group_at",
"-joined_group_at"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetSegmentMemberResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profiles for Segment",
"tags": [
"Segments"
],
"x-klaviyo-filters": {
"_kx": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"email": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"joined_group_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"phone_number": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"profile_id": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"push_token": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_segment_profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"profiles:read",
"segments:read"
]
}
},
"/api/segments/{id}/relationships/flow-triggers": {
"get": {
"description": "Get the IDs of all flows where the given segment is being used as the trigger.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_ids_for_flows_triggered_by_segment.json)",
"operationId": "get_ids_for_flows_triggered_by_segment",
"parameters": [
{
"description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetSegmentFlowTriggersRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get IDs for Flows Triggered by Segment",
"tags": [
"Segments"
],
"x-klaviyo-operation-aliases": [
"get_flow_trigger_ids_for_segment",
"get_segment_relationships_flow_triggers"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read",
"segments:read"
]
}
},
"/api/segments/{id}/relationships/profiles": {
"get": {
"description": "Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api_overview#relationships) for the given segment ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`profiles:read`\n`segments:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_profile_ids_for_segment.json)",
"operationId": "get_profile_ids_for_segment",
"parameters": [
{
"description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "Primary key that uniquely identifies this segment. Generated by Klaviyo.",
"example": "Y6nRLr",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`profile_id`: `any`, `equals`
`email`: `any`, `equals`
`phone_number`: `any`, `equals`
`push_token`: `any`, `equals`
`_kx`: `equals`
`joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(profile_id,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"joined_group_at",
"-joined_group_at"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetSegmentProfilesRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Profile IDs for Segment",
"tags": [
"Segments"
],
"x-klaviyo-filters": {
"_kx": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"email": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"joined_group_at": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"phone_number": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"profile_id": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"push_token": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_segment_relationships_profiles"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"profiles:read",
"segments:read"
]
}
},
"/api/segments/{id}/relationships/tags": {
"get": {
"description": "If `related_resource` is `tags`, returns the tag IDs of all tags associated with the given segment ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_segment.json)",
"operationId": "get_tag_ids_for_segment",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetSegmentTagsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tag IDs for Segment",
"tags": [
"Segments"
],
"x-klaviyo-operation-aliases": [
"get_segment_relationships_tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"segments:read",
"tags:read"
]
}
},
"/api/segments/{id}/tags": {
"get": {
"description": "Return all tags associated with the given segment ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_segment.json)",
"operationId": "get_tags_for_segment",
"parameters": [
{
"description": "",
"in": "path",
"name": "id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tags for Segment",
"tags": [
"Segments"
],
"x-klaviyo-operation-aliases": [
"get_segment_tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"segments:read",
"tags:read"
]
}
},
"/api/tag-groups": {
"get": {
"description": "List all tag groups in an account. Every account has one default tag group.\n\nTag groups can be filtered by `name`, `exclusive`, and `default`, and sorted by `name` or `id` in ascending or descending order.\n\nReturns a maximum of 25 tag groups per request, which can be paginated with\n[cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_groups.json)",
"operationId": "get_tag_groups",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag-group]",
"required": false,
"schema": {
"items": {
"enum": [
"default",
"exclusive",
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`name`: `contains`, `ends-with`, `equals`, `starts-with`
`exclusive`: `equals`
`default`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(name,'My Tag Group')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 25. Min: 1. Max: 25.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 25,
"maximum": 25,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"id",
"-id",
"name",
"-name"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagGroupResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tag Groups",
"tags": [
"Tags"
],
"x-klaviyo-filters": {
"default": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"exclusive": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"name": {
"operators": {
"list": [
"equals"
],
"single": [
"contains",
"ends-with",
"equals",
"starts-with"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read"
],
"x-klaviyo-subtag": "Tag Groups"
},
"post": {
"description": "Create a tag group. An account cannot have more than **50** unique tag groups.\n\nIf `exclusive` is not specified `true` or `false`, the tag group defaults to non-exclusive.\n\nIf a tag group is non-exclusive, any given related resource (campaign, flow, etc.)\ncan be linked to multiple tags from that tag group.\nIf a tag group is exclusive, any given related resource can only be linked to one tag from that tag group.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag_group.json)",
"operationId": "create_tag_group",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag-group]",
"required": false,
"schema": {
"items": {
"enum": [
"default",
"exclusive",
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagGroupCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostTagGroupResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Tag Group",
"tags": [
"Tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read",
"tags:write"
],
"x-klaviyo-subtag": "Tag Groups"
}
},
"/api/tag-groups/{id}": {
"delete": {
"description": "Delete the tag group with the given tag group ID.\n\nAny tags inside that tag group, and any associations between those tags and other resources, will also be removed. The default tag group cannot be deleted.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag_group.json)",
"operationId": "delete_tag_group",
"parameters": [
{
"description": "The Tag Group ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag Group ID",
"example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Tag Group",
"tags": [
"Tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read",
"tags:write"
],
"x-klaviyo-subtag": "Tag Groups"
},
"get": {
"description": "Retrieve the tag group with the given tag group ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group.json)",
"operationId": "get_tag_group",
"parameters": [
{
"description": "The Tag Group ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag Group ID",
"example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag-group]",
"required": false,
"schema": {
"items": {
"enum": [
"default",
"exclusive",
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagGroupResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tag Group",
"tags": [
"Tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read"
],
"x-klaviyo-subtag": "Tag Groups"
},
"patch": {
"description": "Update the tag group with the given tag group ID.\n\nOnly a tag group's `name` can be changed. A tag group's `exclusive` or `default` value cannot be changed.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag_group.json)",
"operationId": "update_tag_group",
"parameters": [
{
"description": "The Tag Group ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag Group ID",
"example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagGroupUpdateQuery"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Tag Group",
"tags": [
"Tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read",
"tags:write"
],
"x-klaviyo-subtag": "Tag Groups"
}
},
"/api/tag-groups/{id}/relationships/tags": {
"get": {
"description": "Returns the tag IDs of all tags inside the given tag group.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_ids_for_tag_group.json)",
"operationId": "get_tag_ids_for_tag_group",
"parameters": [
{
"description": "The Tag Group ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag Group ID",
"example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagGroupTagsRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tag IDs for Tag Group",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"get_tag_group_relationships_tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read"
],
"x-klaviyo-subtag": "Tag Groups"
}
},
"/api/tag-groups/{id}/tags": {
"get": {
"description": "Return the tags for a given tag group ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags_for_tag_group.json)",
"operationId": "get_tags_for_tag_group",
"parameters": [
{
"description": "The Tag Group ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag Group ID",
"example": "zyxw9876-vu54-ts32-rq10-zyxwvu654321",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tags for Tag Group",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"get_tag_group_tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read"
],
"x-klaviyo-subtag": "Tag Groups"
}
},
"/api/tags": {
"get": {
"description": "List all tags in an account.\n\nTags can be filtered by `name`, and sorted by `name` or `id` in ascending or descending order.\n\nReturns a maximum of 50 tags per request, which can be paginated with\n[cursor-based pagination](https://developers.klaviyo.com/en/v2022-10-17/reference/api_overview#pagination).
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tags.json)",
"operationId": "get_tags",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag-group]",
"required": false,
"schema": {
"items": {
"enum": [
"default",
"exclusive",
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`name`: `contains`, `ends-with`, `equals`, `starts-with`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(name,'My Tag')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"tag-group"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 50. Min: 1. Max: 50.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 50,
"maximum": 50,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"id",
"-id",
"name",
"-name"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tags",
"tags": [
"Tags"
],
"x-klaviyo-filters": {
"name": {
"operators": {
"list": [
"equals"
],
"single": [
"contains",
"ends-with",
"equals",
"starts-with"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read"
]
},
"post": {
"description": "Create a tag. An account cannot have more than **500** unique tags.\n\nA tag belongs to a single tag group. If `relationships.tag-group.data.id` is not specified,\nthe tag is added to the account's default tag group.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_tag.json)",
"operationId": "create_tag",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostTagResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Tag",
"tags": [
"Tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read",
"tags:write"
]
}
},
"/api/tags/{id}": {
"delete": {
"description": "Delete the tag with the given tag ID. Any associations between the tag and other resources will also be removed.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_tag.json)",
"operationId": "delete_tag",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Tag",
"tags": [
"Tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read",
"tags:write"
]
},
"get": {
"description": "Retrieve the tag with the given tag ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag.json)",
"operationId": "get_tag",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag-group]",
"required": false,
"schema": {
"items": {
"enum": [
"default",
"exclusive",
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"tag-group"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tag",
"tags": [
"Tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read"
]
},
"patch": {
"description": "Update the tag with the given tag ID.\n\nOnly a tag's `name` can be changed. A tag cannot be moved from one tag group to another.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tag.json)",
"operationId": "update_tag",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagUpdateQuery"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Tag",
"tags": [
"Tags"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read",
"tags:write"
]
}
},
"/api/tags/{id}/relationships/campaigns": {
"delete": {
"description": "Remove a tag's association with one or more campaigns.\n\n\nUse the request body to pass in the ID(s) of the campaign(s) whose association with the tag\nwill be removed.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`campaigns:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_campaigns.json)",
"operationId": "remove_tag_from_campaigns",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagCampaignOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Remove Tag from Campaigns",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"delete_tag_relationships_campaigns",
"remove_campaigns_from_tag"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"campaigns:write",
"tags:write"
]
},
"get": {
"description": "Returns the IDs of all campaigns associated with the given tag.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`campaigns:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_campaign_ids_for_tag.json)",
"operationId": "get_campaign_ids_for_tag",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagCampaignRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Campaign IDs for Tag",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"get_tag_relationships_campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"campaigns:read",
"tags:read"
]
},
"post": {
"description": "Associate a tag with one or more campaigns. Any campaign cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the campaign(s) that will be associated with the tag.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`campaigns:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_campaigns.json)",
"operationId": "tag_campaigns",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagCampaignOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Tag Campaigns",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"create_tag_relationships_campaign",
"add_campaigns_to_tag",
"create_tag_relationships_campaigns"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"campaigns:write",
"tags:write"
]
}
},
"/api/tags/{id}/relationships/flows": {
"delete": {
"description": "Remove a tag's association with one or more flows.\n\n\nUse the request body to pass in the ID(s) of the flows(s) whose association with the tag\nwill be removed.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_flows.json)",
"operationId": "remove_tag_from_flows",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagFlowOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Remove Tag from Flows",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"delete_tag_relationships_flows",
"remove_flows_from_tag"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:write",
"tags:write"
]
},
"get": {
"description": "Returns the IDs of all flows associated with the given tag.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_flow_ids_for_tag.json)",
"operationId": "get_flow_ids_for_tag",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagFlowRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Flow IDs for Tag",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"get_tag_relationships_flows"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:read",
"tags:read"
]
},
"post": {
"description": "Associate a tag with one or more flows. Any flow cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the flow(s) that will be associated with the tag.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`flows:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_flows.json)",
"operationId": "tag_flows",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagFlowOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Tag Flows",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"create_tag_relationships_flow",
"add_flows_to_tag",
"create_tag_relationships_flows"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"flows:write",
"tags:write"
]
}
},
"/api/tags/{id}/relationships/lists": {
"delete": {
"description": "Remove a tag's association with one or more lists.\n\n\nUse the request body to pass in the ID(s) of the list(s) whose association with the tag\nwill be removed.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`lists:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_lists.json)",
"operationId": "remove_tag_from_lists",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagListOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Remove Tag from Lists",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"delete_tag_relationships_lists",
"remove_lists_from_tag"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"lists:write",
"tags:write"
]
},
"get": {
"description": "Returns the IDs of all lists associated with the given tag.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`lists:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_list_ids_for_tag.json)",
"operationId": "get_list_ids_for_tag",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagListRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get List IDs for Tag",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"get_tag_relationships_lists"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"lists:read",
"tags:read"
]
},
"post": {
"description": "Associate a tag with one or more lists. Any list cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the lists(s) that will be associated with the tag.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`lists:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_lists.json)",
"operationId": "tag_lists",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagListOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Tag Lists",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"create_tag_relationships_list",
"add_lists_to_tag",
"create_tag_relationships_lists"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"lists:write",
"tags:write"
]
}
},
"/api/tags/{id}/relationships/segments": {
"delete": {
"description": "Remove a tag's association with one or more segments.\n\n\nUse the request body to pass in the ID(s) of the segments(s) whose association with the tag\nwill be removed.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`segments:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/remove_tag_from_segments.json)",
"operationId": "remove_tag_from_segments",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagSegmentOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Remove Tag from Segments",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"delete_tag_relationships_segments",
"remove_segments_from_tag"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"segments:write",
"tags:write"
]
},
"get": {
"description": "Returns the IDs of all segments associated with the given tag.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`segments:read`\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_segment_ids_for_tag.json)",
"operationId": "get_segment_ids_for_tag",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagSegmentRelationshipsResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Segment IDs for Tag",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"get_tag_relationships_segments"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"segments:read",
"tags:read"
]
},
"post": {
"description": "Associate a tag with one or more segments. Any segment cannot be associated with more than **100** tags.\n\n\nUse the request body to pass in the ID(s) of the segments(s) that will be associated with the tag.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`segments:write`\n`tags:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/tag_segments.json)",
"operationId": "tag_segments",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TagSegmentOp"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Tag Segments",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"create_tag_relationships_segment",
"add_segments_to_tag",
"create_tag_relationships_segments"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"segments:write",
"tags:write"
]
}
},
"/api/tags/{id}/relationships/tag-group": {
"get": {
"description": "Returns the id of the tag group related to the given tag.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_id_for_tag.json)",
"operationId": "get_tag_group_id_for_tag",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagGroupRelationshipResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tag Group ID for Tag",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"get_tag_relationships_tag_group",
"get_group_id_for_tag",
"get_tag_relationships_group"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read"
]
}
},
"/api/tags/{id}/tag-group": {
"get": {
"description": "Returns the tag group resource for a given tag ID.
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`tags:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tag_group_for_tag.json)",
"operationId": "get_tag_group_for_tag",
"parameters": [
{
"description": "The Tag ID",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The Tag ID",
"example": "abcd1234-ef56-gh78-ij90-abcdef123456",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tag-group]",
"required": false,
"schema": {
"items": {
"enum": [
"default",
"exclusive",
"id",
"name"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTagGroupResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tag Group for Tag",
"tags": [
"Tags"
],
"x-klaviyo-operation-aliases": [
"get_tag_tag_group",
"get_group_for_tag"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"tags:read"
]
}
},
"/api/template-clone": {
"post": {
"description": "Create a clone of a template with the given template ID.\n\nIf there are 1,000 or more templates in an account, cloning will fail as there is a limit of 1,000 templates\nthat can be created via the API.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/clone_template.json)",
"operationId": "clone_template",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TemplateCloneQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostTemplateResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Clone Template",
"tags": [
"Templates"
],
"x-klaviyo-operation-aliases": [
"create_template_clone"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:write"
]
}
},
"/api/template-render": {
"post": {
"description": "Render a template with the given template ID and context attribute. Returns the AMP, HTML, and plain text versions of the email template.\n\n**Request body parameters** (nested under `attributes`):\n\n* `return_fields`: Request specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets).\n\n* `context`: This is the context your email template will be rendered with. You must pass in a `context` object as a JSON object.\n\nEmail templates are rendered with contexts in a similar manner to Django templates. Nested template variables can be referenced via dot notation. Template variables without corresponding `context` values are treated as `FALSE` and output nothing.\n\nEx. `{ \"name\" : \"George Washington\", \"state\" : \"VA\" }`
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/render_template.json)",
"operationId": "render_template",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TemplateRenderQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostTemplateResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Render Template",
"tags": [
"Templates"
],
"x-klaviyo-operation-aliases": [
"create_template_render"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": [
"templates:read"
]
}
},
"/api/template-universal-content": {
"get": {
"description": "Get all universal content in an account.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_all_universal_content.json)",
"operationId": "get_all_universal_content",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template-universal-content]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.content_type",
"definition.data",
"definition.data.content",
"definition.data.display_options",
"definition.data.display_options.content_repeat",
"definition.data.display_options.content_repeat.item_alias",
"definition.data.display_options.content_repeat.repeat_for",
"definition.data.display_options.show_on",
"definition.data.display_options.visible_check",
"definition.data.styles",
"definition.data.styles.background_color",
"definition.data.styles.block_background_color",
"definition.data.styles.block_border_color",
"definition.data.styles.block_border_style",
"definition.data.styles.block_border_width",
"definition.data.styles.block_padding_bottom",
"definition.data.styles.block_padding_left",
"definition.data.styles.block_padding_right",
"definition.data.styles.block_padding_top",
"definition.data.styles.color",
"definition.data.styles.extra_css_class",
"definition.data.styles.font_family",
"definition.data.styles.font_size",
"definition.data.styles.font_style",
"definition.data.styles.font_weight",
"definition.data.styles.inner_padding_bottom",
"definition.data.styles.inner_padding_left",
"definition.data.styles.inner_padding_right",
"definition.data.styles.inner_padding_top",
"definition.data.styles.letter_spacing",
"definition.data.styles.line_height",
"definition.data.styles.mobile_stretch_content",
"definition.data.styles.text_align",
"definition.data.styles.text_decoration",
"definition.data.styles.text_table_layout",
"definition.type",
"id",
"name",
"screenshot_status",
"screenshot_url",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`, `equals`
`name`: `any`, `equals`
`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`definition.content_type`: `equals`
`definition.type`: `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(id,'01HWWWKAW4RHXQJCMW4R2KRYR4')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created",
"id",
"-id",
"name",
"-name",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetUniversalContentResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get All Universal Content",
"tags": [
"Templates"
],
"x-klaviyo-filters": {
"created": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"definition.content_type": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"block",
"section"
],
"type": "string"
}
},
"definition.type": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"button",
"coupon",
"drop_shadow",
"header",
"horizontal_rule",
"html",
"image",
"product",
"review",
"social",
"spacer",
"split",
"table",
"text",
"unsupported",
"video"
],
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-operation-aliases": [
"get_template_universal_content"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:read"
],
"x-klaviyo-subtag": "Universal Content"
},
"post": {
"description": "Create universal content. Currently supported block types are: `button`, `drop_shadow`, `horizontal_rule`, `html`, `image`, `spacer`, and `text`.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_universal_content.json)",
"operationId": "create_universal_content",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template-universal-content]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.content_type",
"definition.data",
"definition.data.content",
"definition.data.display_options",
"definition.data.display_options.content_repeat",
"definition.data.display_options.content_repeat.item_alias",
"definition.data.display_options.content_repeat.repeat_for",
"definition.data.display_options.show_on",
"definition.data.display_options.visible_check",
"definition.data.styles",
"definition.data.styles.background_color",
"definition.data.styles.block_background_color",
"definition.data.styles.block_border_color",
"definition.data.styles.block_border_style",
"definition.data.styles.block_border_width",
"definition.data.styles.block_padding_bottom",
"definition.data.styles.block_padding_left",
"definition.data.styles.block_padding_right",
"definition.data.styles.block_padding_top",
"definition.data.styles.color",
"definition.data.styles.extra_css_class",
"definition.data.styles.font_family",
"definition.data.styles.font_size",
"definition.data.styles.font_style",
"definition.data.styles.font_weight",
"definition.data.styles.inner_padding_bottom",
"definition.data.styles.inner_padding_left",
"definition.data.styles.inner_padding_right",
"definition.data.styles.inner_padding_top",
"definition.data.styles.letter_spacing",
"definition.data.styles.line_height",
"definition.data.styles.mobile_stretch_content",
"definition.data.styles.text_align",
"definition.data.styles.text_decoration",
"definition.data.styles.text_table_layout",
"definition.type",
"id",
"name",
"screenshot_status",
"screenshot_url",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/UniversalContentCreateQuery"
}
}
},
"description": "Create a template universal content",
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostUniversalContentResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Universal Content",
"tags": [
"Templates"
],
"x-klaviyo-operation-aliases": [
"create_template_universal_content"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:write"
],
"x-klaviyo-subtag": "Universal Content"
}
},
"/api/template-universal-content/{id}": {
"delete": {
"description": "Delete the universal content with the given ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_universal_content.json)",
"operationId": "delete_universal_content",
"parameters": [
{
"description": "The ID of the template universal content",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the template universal content",
"example": "01HWWWKAW4RHXQJCMW4R2KRYR4",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Universal Content",
"tags": [
"Templates"
],
"x-klaviyo-operation-aliases": [
"delete_template_universal_content"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:write"
],
"x-klaviyo-subtag": "Universal Content"
},
"get": {
"description": "Get the universal content with the given ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_universal_content.json)",
"operationId": "get_universal_content",
"parameters": [
{
"description": "The ID of the universal content",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the universal content",
"example": "01HWWWKAW4RHXQJCMW4R2KRYR4",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template-universal-content]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.content_type",
"definition.data",
"definition.data.content",
"definition.data.display_options",
"definition.data.display_options.content_repeat",
"definition.data.display_options.content_repeat.item_alias",
"definition.data.display_options.content_repeat.repeat_for",
"definition.data.display_options.show_on",
"definition.data.display_options.visible_check",
"definition.data.styles",
"definition.data.styles.background_color",
"definition.data.styles.block_background_color",
"definition.data.styles.block_border_color",
"definition.data.styles.block_border_style",
"definition.data.styles.block_border_width",
"definition.data.styles.block_padding_bottom",
"definition.data.styles.block_padding_left",
"definition.data.styles.block_padding_right",
"definition.data.styles.block_padding_top",
"definition.data.styles.color",
"definition.data.styles.extra_css_class",
"definition.data.styles.font_family",
"definition.data.styles.font_size",
"definition.data.styles.font_style",
"definition.data.styles.font_weight",
"definition.data.styles.inner_padding_bottom",
"definition.data.styles.inner_padding_left",
"definition.data.styles.inner_padding_right",
"definition.data.styles.inner_padding_top",
"definition.data.styles.letter_spacing",
"definition.data.styles.line_height",
"definition.data.styles.mobile_stretch_content",
"definition.data.styles.text_align",
"definition.data.styles.text_decoration",
"definition.data.styles.text_table_layout",
"definition.type",
"id",
"name",
"screenshot_status",
"screenshot_url",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetUniversalContentResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Universal Content",
"tags": [
"Templates"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:read"
],
"x-klaviyo-subtag": "Universal Content"
},
"patch": {
"description": "Update universal content. The `definition` field can only be updated on the following block types at this time: `button`, `drop_shadow`, `horizontal_rule`, `html`, `image`, `spacer`, and `text`.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_universal_content.json)",
"operationId": "update_universal_content",
"parameters": [
{
"description": "The ID of the template universal content",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the template universal content",
"example": "01HWWWKAW4RHXQJCMW4R2KRYR4",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template-universal-content]",
"required": false,
"schema": {
"items": {
"enum": [
"created",
"definition",
"definition.content_type",
"definition.data",
"definition.data.content",
"definition.data.display_options",
"definition.data.display_options.content_repeat",
"definition.data.display_options.content_repeat.item_alias",
"definition.data.display_options.content_repeat.repeat_for",
"definition.data.display_options.show_on",
"definition.data.display_options.visible_check",
"definition.data.styles",
"definition.data.styles.background_color",
"definition.data.styles.block_background_color",
"definition.data.styles.block_border_color",
"definition.data.styles.block_border_style",
"definition.data.styles.block_border_width",
"definition.data.styles.block_padding_bottom",
"definition.data.styles.block_padding_left",
"definition.data.styles.block_padding_right",
"definition.data.styles.block_padding_top",
"definition.data.styles.color",
"definition.data.styles.extra_css_class",
"definition.data.styles.font_family",
"definition.data.styles.font_size",
"definition.data.styles.font_style",
"definition.data.styles.font_weight",
"definition.data.styles.inner_padding_bottom",
"definition.data.styles.inner_padding_left",
"definition.data.styles.inner_padding_right",
"definition.data.styles.inner_padding_top",
"definition.data.styles.letter_spacing",
"definition.data.styles.line_height",
"definition.data.styles.mobile_stretch_content",
"definition.data.styles.text_align",
"definition.data.styles.text_decoration",
"definition.data.styles.text_table_layout",
"definition.type",
"id",
"name",
"screenshot_status",
"screenshot_url",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/UniversalContentPartialUpdateQuery"
}
}
},
"description": "Update a universal content by ID",
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchUniversalContentResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Universal Content",
"tags": [
"Templates"
],
"x-klaviyo-operation-aliases": [
"update_template_universal_content"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:write"
],
"x-klaviyo-subtag": "Universal Content"
}
},
"/api/templates": {
"get": {
"description": "Get all templates in an account.\n\nUse `additional-fields[template]=definition` to include the full template\ndefinition for SYSTEM_DRAGGABLE templates.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_templates.json)",
"operationId": "get_templates",
"parameters": [
{
"description": "Request additional fields not included by default in the response. Supported values: 'definition'",
"explode": false,
"in": "query",
"name": "additional-fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"definition"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"definition",
"definition.body",
"definition.body.id",
"definition.body.properties",
"definition.body.properties.css_class",
"definition.body.properties.id",
"definition.body.sections",
"definition.body.styles",
"definition.body.styles.background_color",
"definition.body.styles.width",
"definition.id",
"definition.styles",
"definition.template_id",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`, `equals`
`name`: `any`, `contains`, `equals`
`created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(id,['example'])",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 10. Min: 1. Max: 10.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 10,
"maximum": 10,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created",
"id",
"-id",
"name",
"-name",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTemplateDndResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Templates",
"tags": [
"Templates"
],
"x-klaviyo-filters": {
"created": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"id": {
"operators": {
"list": [
"any",
"equals"
]
},
"value": {
"type": "string"
}
},
"name": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"contains",
"equals"
]
},
"value": {
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"equals",
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:read"
]
},
"post": {
"description": "Create a new HTML or drag-and-drop template.\n\nIf there are 1,000 or more templates in an account, creation will fail as there is a limit of 1,000 templates\nthat can be created via the API.\n\nRequest specific fields using [sparse fieldsets](https://developers.klaviyo.com/en/reference/api_overview#sparse-fieldsets).
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_template.json)",
"operationId": "create_template",
"parameters": [
{
"description": "Request additional fields not included by default in the response. Supported values: 'definition'",
"explode": false,
"in": "query",
"name": "additional-fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"definition"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"definition",
"definition.body",
"definition.body.id",
"definition.body.properties",
"definition.body.properties.css_class",
"definition.body.properties.id",
"definition.body.sections",
"definition.body.styles",
"definition.body.styles.background_color",
"definition.body.styles.width",
"definition.id",
"definition.styles",
"definition.template_id",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TemplateCreateHtmlOrDndQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostTemplateDndResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Template",
"tags": [
"Templates"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:write"
]
}
},
"/api/templates/{id}": {
"delete": {
"description": "Delete a template with the given template ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_template.json)",
"operationId": "delete_template",
"parameters": [
{
"description": "The ID of template",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of template",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Template",
"tags": [
"Templates"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:write"
]
},
"get": {
"description": "Get a template with the given template ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_template.json)",
"operationId": "get_template",
"parameters": [
{
"description": "The ID of template",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of template",
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'definition'",
"explode": false,
"in": "query",
"name": "additional-fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"definition"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"definition",
"definition.body",
"definition.body.id",
"definition.body.properties",
"definition.body.properties.css_class",
"definition.body.properties.id",
"definition.body.sections",
"definition.body.styles",
"definition.body.styles.background_color",
"definition.body.styles.width",
"definition.id",
"definition.styles",
"definition.template_id",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTemplateDndResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Template",
"tags": [
"Templates"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:read"
]
},
"patch": {
"description": "Update a template with the given template ID.
*Rate limits*:
Burst: `75/s`
Steady: `750/m`\n\n**Scopes:**\n`templates:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_template.json)",
"operationId": "update_template",
"parameters": [
{
"description": "The ID of template",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of template",
"type": "string"
}
},
{
"description": "Request additional fields not included by default in the response. Supported values: 'definition'",
"explode": false,
"in": "query",
"name": "additional-fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"definition"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[template]",
"required": false,
"schema": {
"items": {
"enum": [
"amp",
"created",
"definition",
"definition.body",
"definition.body.id",
"definition.body.properties",
"definition.body.properties.css_class",
"definition.body.properties.id",
"definition.body.sections",
"definition.body.styles",
"definition.body.styles.background_color",
"definition.body.styles.width",
"definition.id",
"definition.styles",
"definition.template_id",
"editor_type",
"html",
"id",
"name",
"text",
"updated"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TemplateUpdateHtmlOrDndQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchTemplateDndResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Template",
"tags": [
"Templates"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "75/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"templates:write"
]
}
},
"/api/tracking-settings": {
"get": {
"description": "Get all UTM tracking settings in an account. Returns an array with a single tracking setting.\n\nMore information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`tracking-settings:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_settings.json)",
"operationId": "get_tracking_settings",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tracking-setting]",
"required": false,
"schema": {
"items": {
"enum": [
"auto_add_parameters",
"custom_parameters",
"id",
"utm_campaign",
"utm_campaign.campaign",
"utm_campaign.campaign.type",
"utm_campaign.campaign.value",
"utm_campaign.flow",
"utm_campaign.flow.type",
"utm_campaign.flow.value",
"utm_id",
"utm_id.campaign",
"utm_id.campaign.type",
"utm_id.campaign.value",
"utm_id.flow",
"utm_id.flow.type",
"utm_id.flow.value",
"utm_medium",
"utm_medium.campaign",
"utm_medium.campaign.type",
"utm_medium.campaign.value",
"utm_medium.flow",
"utm_medium.flow.type",
"utm_medium.flow.value",
"utm_source",
"utm_source.campaign",
"utm_source.campaign.type",
"utm_source.campaign.value",
"utm_source.flow",
"utm_source.flow.type",
"utm_source.flow.value",
"utm_term",
"utm_term.campaign",
"utm_term.campaign.type",
"utm_term.campaign.value",
"utm_term.flow",
"utm_term.flow.type",
"utm_term.flow.value"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 1. Min: 1. Max: 1.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 1,
"maximum": 1,
"minimum": 1,
"type": "integer"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTrackingSettingResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tracking Settings",
"tags": [
"Tracking Settings"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"tracking-settings:read"
]
}
},
"/api/tracking-settings/{id}": {
"get": {
"description": "Get the UTM tracking setting with the given account ID.\n\nMore information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`tracking-settings:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_tracking_setting.json)",
"operationId": "get_tracking_setting",
"parameters": [
{
"description": "The id of the tracking setting (account ID).",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The id of the tracking setting (account ID).",
"example": "abCdEf",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tracking-setting]",
"required": false,
"schema": {
"items": {
"enum": [
"auto_add_parameters",
"custom_parameters",
"id",
"utm_campaign",
"utm_campaign.campaign",
"utm_campaign.campaign.type",
"utm_campaign.campaign.value",
"utm_campaign.flow",
"utm_campaign.flow.type",
"utm_campaign.flow.value",
"utm_id",
"utm_id.campaign",
"utm_id.campaign.type",
"utm_id.campaign.value",
"utm_id.flow",
"utm_id.flow.type",
"utm_id.flow.value",
"utm_medium",
"utm_medium.campaign",
"utm_medium.campaign.type",
"utm_medium.campaign.value",
"utm_medium.flow",
"utm_medium.flow.type",
"utm_medium.flow.value",
"utm_source",
"utm_source.campaign",
"utm_source.campaign.type",
"utm_source.campaign.value",
"utm_source.flow",
"utm_source.flow.type",
"utm_source.flow.value",
"utm_term",
"utm_term.campaign",
"utm_term.campaign.type",
"utm_term.campaign.value",
"utm_term.flow",
"utm_term.flow.type",
"utm_term.flow.value"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetTrackingSettingResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Tracking Setting",
"tags": [
"Tracking Settings"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"tracking-settings:read"
]
},
"patch": {
"description": "Update the UTM tracking setting with the given account ID.\n\nMore information about UTM tracking settings can be found [here](https://help.klaviyo.com/hc/en-us/articles/115005247808).
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`tracking-settings:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_tracking_setting.json)",
"operationId": "update_tracking_setting",
"parameters": [
{
"description": "The id of the tracking setting (account ID).",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The id of the tracking setting (account ID).",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[tracking-setting]",
"required": false,
"schema": {
"items": {
"enum": [
"auto_add_parameters",
"custom_parameters",
"id",
"utm_campaign",
"utm_campaign.campaign",
"utm_campaign.campaign.type",
"utm_campaign.campaign.value",
"utm_campaign.flow",
"utm_campaign.flow.type",
"utm_campaign.flow.value",
"utm_id",
"utm_id.campaign",
"utm_id.campaign.type",
"utm_id.campaign.value",
"utm_id.flow",
"utm_id.flow.type",
"utm_id.flow.value",
"utm_medium",
"utm_medium.campaign",
"utm_medium.campaign.type",
"utm_medium.campaign.value",
"utm_medium.flow",
"utm_medium.flow.type",
"utm_medium.flow.value",
"utm_source",
"utm_source.campaign",
"utm_source.campaign.type",
"utm_source.campaign.value",
"utm_source.flow",
"utm_source.flow.type",
"utm_source.flow.value",
"utm_term",
"utm_term.campaign",
"utm_term.campaign.type",
"utm_term.campaign.value",
"utm_term.flow",
"utm_term.flow.type",
"utm_term.flow.value"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/TrackingSettingPartialUpdateQuery"
}
}
},
"description": "DTO for updating tracking settings",
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchTrackingSettingResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Tracking Setting",
"tags": [
"Tracking Settings"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"tracking-settings:write"
]
}
},
"/api/web-feeds": {
"get": {
"description": "Get all web feeds for an account.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`web-feeds:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feeds.json)",
"operationId": "get_web_feeds",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[web-feed]",
"required": false,
"schema": {
"items": {
"enum": [
"content_type",
"created",
"id",
"name",
"request_method",
"status",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`name`: `any`, `contains`, `equals`
`created`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
`updated`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(name,'Blog_posts')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 5. Min: 1. Max: 20.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 5,
"maximum": 20,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created",
"name",
"-name",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetWebFeedResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Web Feeds",
"tags": [
"Web Feeds"
],
"x-klaviyo-filters": {
"created": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"name": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"contains",
"equals"
]
},
"value": {
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"greater-or-equal",
"greater-than",
"less-or-equal",
"less-than"
]
},
"value": {
"format": "date-time",
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"web-feeds:read"
]
},
"post": {
"description": "Create a web feed.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`web-feeds:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_web_feed.json)",
"operationId": "create_web_feed",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[web-feed]",
"required": false,
"schema": {
"items": {
"enum": [
"content_type",
"created",
"id",
"name",
"request_method",
"status",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/WebFeedCreateQuery"
}
}
},
"description": "Create a web feed",
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostWebFeedResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Web Feed",
"tags": [
"Web Feeds"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"web-feeds:write"
]
}
},
"/api/web-feeds/{id}": {
"delete": {
"description": "Delete the web feed with the given ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`web-feeds:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_web_feed.json)",
"operationId": "delete_web_feed",
"parameters": [
{
"description": "The ID of the web feed",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the web feed",
"example": "925e385b52fb",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Web Feed",
"tags": [
"Web Feeds"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"web-feeds:write"
]
},
"get": {
"description": "Get the web feed with the given ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`web-feeds:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_web_feed.json)",
"operationId": "get_web_feed",
"parameters": [
{
"description": "The ID of the web feed",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the web feed",
"example": "925e385b52fb",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[web-feed]",
"required": false,
"schema": {
"items": {
"enum": [
"content_type",
"created",
"id",
"name",
"request_method",
"status",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetWebFeedResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Web Feed",
"tags": [
"Web Feeds"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"web-feeds:read"
]
},
"patch": {
"description": "Update the web feed with the given ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`web-feeds:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_web_feed.json)",
"operationId": "update_web_feed",
"parameters": [
{
"description": "The ID of the web feed",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the web feed",
"example": "925e385b52fb",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[web-feed]",
"required": false,
"schema": {
"items": {
"enum": [
"content_type",
"created",
"id",
"name",
"request_method",
"status",
"updated",
"url"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/WebFeedPartialUpdateQuery"
}
}
},
"description": "Update a web feed by ID",
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchWebFeedResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Web Feed",
"tags": [
"Web Feeds"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"web-feeds:write"
]
}
},
"/api/webhook-topics": {
"get": {
"description": "Get all webhook topics in a Klaviyo account.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topics.json)",
"operationId": "get_webhook_topics",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[webhook-topic]",
"required": false,
"schema": {
"items": {
"enum": [
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetWebhookTopicResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Webhook Topics",
"tags": [
"Webhooks"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"webhooks:read"
]
}
},
"/api/webhook-topics/{id}": {
"get": {
"description": "Get the webhook topic with the given ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook_topic.json)",
"operationId": "get_webhook_topic",
"parameters": [
{
"description": "The ID of the webhook topic.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the webhook topic.",
"example": "event:klaviyo.sent_sms",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[webhook-topic]",
"required": false,
"schema": {
"items": {
"enum": [
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetWebhookTopicResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Webhook Topic",
"tags": [
"Webhooks"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"webhooks:read"
]
}
},
"/api/webhooks": {
"get": {
"description": "Get all webhooks in an account.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhooks.json)",
"operationId": "get_webhooks",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[webhook-topic]",
"required": false,
"schema": {
"items": {
"enum": [
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[webhook]",
"required": false,
"schema": {
"items": {
"enum": [
"created_at",
"description",
"enabled",
"endpoint_url",
"id",
"name",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"webhook-topics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetWebhookResponseCollectionCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Webhooks",
"tags": [
"Webhooks"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"webhooks:read"
]
},
"post": {
"description": "Create a new Webhook
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`webhooks:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_webhook.json)",
"operationId": "create_webhook",
"parameters": [
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[webhook]",
"required": false,
"schema": {
"items": {
"enum": [
"created_at",
"description",
"enabled",
"endpoint_url",
"id",
"name",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/WebhookCreateQuery"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PostWebhookResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Create Webhook",
"tags": [
"Webhooks"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"webhooks:write"
]
}
},
"/api/webhooks/{id}": {
"delete": {
"description": "Delete a webhook with the given ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`webhooks:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/delete_webhook.json)",
"operationId": "delete_webhook",
"parameters": [
{
"description": "The ID of the webhook.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the webhook.",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Delete Webhook",
"tags": [
"Webhooks"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"webhooks:write"
]
},
"get": {
"description": "Get the webhook with the given ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`webhooks:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_webhook.json)",
"operationId": "get_webhook",
"parameters": [
{
"description": "The ID of the webhook.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the webhook.",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[webhook-topic]",
"required": false,
"schema": {
"items": {
"enum": [
"id"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[webhook]",
"required": false,
"schema": {
"items": {
"enum": [
"created_at",
"description",
"enabled",
"endpoint_url",
"id",
"name",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#relationships",
"explode": false,
"in": "query",
"name": "include",
"schema": {
"items": {
"enum": [
"webhook-topics"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetWebhookResponseCompoundDocument"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Get Webhook",
"tags": [
"Webhooks"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"webhooks:read"
]
},
"patch": {
"description": "Update the webhook with the given ID.
*Rate limits*:
Burst: `1/s`
Steady: `15/m`\n\n**Scopes:**\n`webhooks:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/update_webhook.json)",
"operationId": "update_webhook",
"parameters": [
{
"description": "The ID of the webhook.",
"in": "path",
"name": "id",
"required": true,
"schema": {
"description": "The ID of the webhook.",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[webhook]",
"required": false,
"schema": {
"items": {
"enum": [
"created_at",
"description",
"enabled",
"endpoint_url",
"id",
"name",
"updated_at"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/WebhookPartialUpdateQuery"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PatchWebhookResponse"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"summary": "Update Webhook",
"tags": [
"Webhooks"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "1/s",
"steady": "15/m"
},
"x-klaviyo-scopes": [
"webhooks:write"
]
}
},
"/client/back-in-stock-subscriptions": {
"post": {
"description": "Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API guide](https://developers.klaviyo.com/en/docs/how_to_set_up_custom_back_in_stock) for more details.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create back in stock subscriptions from server-side applications, instead use [POST /api/back-in-stock-subscriptions](https://developers.klaviyo.com/en/reference/create_back_in_stock_subscription).
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`catalogs:write`\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_back_in_stock_subscription.json)",
"operationId": "create_client_back_in_stock_subscription",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ClientBISSubscriptionCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Create Client Back In Stock Subscription",
"tags": [
"Client"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"catalogs:write",
"profiles:write"
]
}
},
"/client/event-bulk-create": {
"post": {
"description": "Create new events to track a profile's activity.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create events from server-side applications, instead use [POST /api/event-bulk-create-jobs](https://developers.klaviyo.com/en/reference/bulk_create_events).\n\nAccepts a maximum of `1000` events per request.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/bulk_create_client_events.json)",
"operationId": "bulk_create_client_events",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/EventsBulkCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Bulk Create Client Events",
"tags": [
"Client"
],
"x-klaviyo-operation-aliases": [
"create_client_event_bulk_create"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"events:write"
]
}
},
"/client/events": {
"post": {
"description": "Create a new event to track a profile's activity.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create events from server-side applications, instead use [POST /api/events](https://developers.klaviyo.com/en/reference/create_event).\n\nNote that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`events:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_event.json)",
"operationId": "create_client_event",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/EventCreateQueryV2"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Create Client Event",
"tags": [
"Client"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"events:write"
]
}
},
"/client/geofences": {
"get": {
"description": "Get all geofences in an account.\n\nReturns a paginated list of all geofences for the specified company.\nThis is the GA API endpoint designed for mobile SDK consumption.\nNo authentication required.\n\nReturns a maximum of 100 results per page (default 20).\n\nThis API supports filtering via header instead of query param. Provide\n`X-Klaviyo-API-Filters` header to filter geofences. We don't use regular\nquery param filters here because lat and long are sensitive information.\n\nSupported filters:\n- `lat` (equals) - Latitude coordinate for distance-based sorting\n- `lng` (equals) - Longitude coordinate for distance-based sorting\n\nWhen both lat and lng are provided, geofences are returned sorted by\ndistance from the specified coordinates (closest first).\n\nExample filter header:\n`X-Klaviyo-API-Filters: and(equals(lat,40.7128),equals(lng,-74.0060))`
*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_geofences.json)",
"operationId": "get_client_geofences",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[geofence]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"latitude",
"longitude",
"radius"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "\nSupported filters:\n- `lat` (equals) - Latitude coordinate for distance-based sorting\n- `lng` (equals) - Longitude coordinate for distance-based sorting\n\nWhen both lat and lng are provided, geofences are returned sorted by\ndistance from the specified coordinates (closest first).\n",
"in": "header",
"name": "X-Klaviyo-API-Filters",
"required": false,
"schema": {
"example": "and(equals(lat,40.7128),equals(lng,-74.0060))",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetGeofenceResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Get Client Geofences",
"tags": [
"Client"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "3/s",
"steady": "60/m"
},
"x-klaviyo-scopes": []
}
},
"/client/profiles": {
"post": {
"description": "Create or update properties about a profile without tracking an associated event.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo create or update profiles from server-side applications, instead use [POST /api/profile-import](https://developers.klaviyo.com/en/reference/create_or_update_profile).\n\nNote that to update a profile's existing identifiers (e.g., email), you must use a server-side endpoint authenticated by a private API key. Attempts to do so via client-side endpoints will return a 202, however the identifier field(s) will not be updated.
*Rate limits*:
Burst: `350/s`
Steady: `3500/m`\n\n**Scopes:**\n`profiles:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_profile.json)",
"operationId": "create_client_profile",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/OnsiteProfileCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Create or Update Client Profile",
"tags": [
"Client"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "3500/m"
},
"x-klaviyo-scopes": [
"profiles:write"
]
}
},
"/client/push-token-unregister": {
"post": {
"description": "Unregister a push token.\n\nThis endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\nYou must have push notifications enabled to use this endpoint.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/unregister_client_push_token.json)",
"operationId": "unregister_client_push_token",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PushTokenUnregisterQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Unregister Client Push Token",
"tags": [
"Client"
],
"x-klaviyo-operation-aliases": [
"create_client_push_token_unregister"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": []
}
},
"/client/push-tokens": {
"post": {
"description": "Create or update a push token.\n\nThis endpoint is specifically designed to be called from our mobile SDKs ([iOS](https://github.com/klaviyo/klaviyo-swift-sdk) and [Android](https://github.com/klaviyo/klaviyo-android-sdk)) and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\nYou must have push notifications enabled to use this endpoint.\n\nTo migrate push tokens from another platform to Klaviyo, please use our server-side [POST /api/push-tokens](https://developers.klaviyo.com/en/reference/create_push_token) endpoint instead.
*Rate limits*:
Burst: `150/s`
Steady: `1400/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_push_token.json)",
"operationId": "create_client_push_token",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/PushTokenCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Create or Update Client Push Token",
"tags": [
"Client"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "150/s",
"steady": "1400/m"
},
"x-klaviyo-scopes": []
}
},
"/client/review-values-reports": {
"get": {
"description": "Get all reviews values reports in an account.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_review_values_reports.json)",
"operationId": "get_client_review_values_reports",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[review-values-report]",
"required": false,
"schema": {
"items": {
"enum": [
"id",
"results"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`product_external_ids`: `any`, `equals`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(product_external_ids,'example')",
"type": "string"
}
},
{
"description": "group by value for this report",
"in": "query",
"name": "group_by",
"required": true,
"schema": {
"description": "group by value for this report",
"enum": [
"company_id",
"product_id"
],
"example": "product_id",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "list of statistics to calculate for this report",
"in": "query",
"name": "statistics",
"required": true,
"schema": {
"description": "list of statistics to calculate for this report",
"example": "average_rating,total_reviews",
"type": "string"
}
},
{
"description": "timeframe window for value report",
"in": "query",
"name": "timeframe",
"required": true,
"schema": {
"description": "timeframe window for value report",
"enum": [
"all_time",
"last_30_days",
"last_365_days",
"last_90_days"
],
"example": "all_time",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetReviewValuesReportResponseCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Get Client Review Values Reports",
"tags": [
"Client"
],
"x-klaviyo-filters": {
"product_external_ids": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": []
}
},
"/client/reviews": {
"get": {
"description": "Get all reviews. This endpoint is for client-side environments only, for server-side use, refer to https://developers.klaviyo.com/en/reference/get_reviews
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/get_client_reviews.json)",
"operationId": "get_client_reviews",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets",
"explode": false,
"in": "query",
"name": "fields[review]",
"required": false,
"schema": {
"items": {
"enum": [
"author",
"content",
"created",
"id",
"images",
"product",
"product.external_id",
"product.image_url",
"product.name",
"product.url",
"public_reply",
"public_reply.author",
"public_reply.content",
"public_reply.updated",
"rating",
"review_type",
"smart_quote",
"status",
"status.rejection_reason",
"status.rejection_reason.reason",
"status.rejection_reason.status_explanation",
"status.value",
"title",
"updated",
"verified"
],
"type": "string"
},
"type": "array"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#filtering
Allowed field(s)/operator(s):
`status`: `equals`
`review_type`: `equals`
`rating`: `any`, `equals`, `greater-or-equal`, `less-or-equal`
`id`: `any`, `equals`
`content`: `contains`
`smart_quote`: `has`
`public_reply`: `has`
`verified`: `equals`
`incentivized`: `equals`
`edited`: `equals`
`media`: `has`
`created`: `greater-or-equal`, `less-or-equal`
`updated`: `greater-or-equal`, `less-or-equal`",
"in": "query",
"name": "filter",
"schema": {
"example": "equals(status,'published')",
"type": "string"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#pagination",
"in": "query",
"name": "page[cursor]",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Default: 20. Min: 1. Max: 100.",
"in": "query",
"name": "page[size]",
"required": false,
"schema": {
"default": 20,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sorting",
"in": "query",
"name": "sort",
"schema": {
"enum": [
"created",
"-created",
"rating",
"-rating",
"updated",
"-updated"
],
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/GetClientReviewResponseDTOCollection"
}
}
},
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Get Client Reviews",
"tags": [
"Client"
],
"x-klaviyo-filters": {
"content": {
"operators": {
"single": [
"contains"
]
},
"value": {
"type": "string"
}
},
"created": {
"operators": {
"single": [
"greater-or-equal",
"less-or-equal"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"edited": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"id": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals"
]
},
"value": {
"type": "string"
}
},
"incentivized": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
},
"media": {
"operators": {
"none": [
"has"
]
}
},
"public_reply": {
"operators": {
"none": [
"has"
]
}
},
"rating": {
"operators": {
"list": [
"any",
"equals"
],
"single": [
"equals",
"greater-or-equal",
"less-or-equal"
]
},
"value": {
"type": "integer"
}
},
"review_type": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"question",
"review",
"rating",
"store"
],
"type": "string"
}
},
"smart_quote": {
"operators": {
"none": [
"has"
]
}
},
"status": {
"operators": {
"single": [
"equals"
]
},
"value": {
"enum": [
"published",
"unpublished",
"rejected",
"featured",
"pending",
"all"
],
"type": "string"
}
},
"updated": {
"operators": {
"single": [
"greater-or-equal",
"less-or-equal"
]
},
"value": {
"format": "date-time",
"type": "string"
}
},
"verified": {
"operators": {
"single": [
"equals"
]
},
"value": {
"type": "boolean"
}
}
},
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": []
},
"post": {
"description": "Create a review with the given ID. This endpoint is for client-side environments only.
*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_review.json)",
"operationId": "create_client_review",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/ReviewCreateDTO"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Create Client Review",
"tags": [
"Client"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": []
}
},
"/client/subscriptions": {
"post": {
"description": "Creates a subscription and consent record for email and/or SMS channels based on the provided `email` and `phone_number` attributes, respectively. One of either `email` or `phone_number` must be provided.\n\nThis endpoint is specifically designed to be called from publicly-browseable, client-side environments only and requires a [public API key (site ID)](https://www.klaviyo.com/settings/account/api-keys). Never use a private API key with our client-side endpoints.\n\nDo not use this endpoint from server-side applications.\nTo subscribe profiles from server-side applications, instead use [POST /api/profile-subscription-bulk-create-jobs](https://developers.klaviyo.com/en/reference/subscribe_profiles).\n\nProfiles can be opted into multiple channels: email marketing, SMS marketing, and SMS transactional. You can specify the channel(s) to subscribe the profile to by providing a subscriptions object in the profile attributes.\n\nIf you include a subscriptions object, only channels in that object will be subscribed. You can use this to update `email` or `phone` on the profile without subscribing them, for example, by setting the profile property but omitting that channel in the subscriptions object. If a subscriptions object is not provided, subscriptions are defaulted to `MARKETING`.
*Rate limits*:
Burst: `350/s`
Steady: `750/m`\n\n**Scopes:**\n`subscriptions:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_client_subscription.json)",
"operationId": "create_client_subscription",
"parameters": [
{
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"in": "query",
"name": "company_id",
"required": true,
"schema": {
"description": "Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.",
"example": "PUBLIC_API_KEY",
"type": "string"
}
},
{
"description": "API endpoint revision (format: YYYY-MM-DD[.suffix])",
"in": "header",
"name": "revision",
"required": true,
"schema": {
"default": "2026-04-15",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/vnd.api+json": {
"schema": {
"$ref": "#/components/schemas/OnsiteSubscriptionCreateQuery"
}
}
},
"required": true
},
"responses": {
"202": {
"description": "Success"
},
"4XX": {
"$ref": "#/components/responses/ClientError"
},
"5XX": {
"$ref": "#/components/responses/ServerError"
}
},
"security": [],
"summary": "Create Client Subscription",
"tags": [
"Client"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "350/s",
"steady": "750/m"
},
"x-klaviyo-scopes": [
"subscriptions:write"
]
}
}
},
"security": [
{
"Klaviyo-API-Key": []
}
],
"servers": [
{
"description": "Production",
"url": "https://a.klaviyo.com"
}
],
"tags": [
{
"description": "accounts",
"name": "Accounts"
},
{
"description": "campaigns",
"name": "Campaigns"
},
{
"description": "catalogs",
"name": "Catalogs"
},
{
"description": "conversations",
"name": "Conversations"
},
{
"description": "coupons",
"name": "Coupons"
},
{
"description": "custom objects",
"name": "Custom Objects"
},
{
"description": "data privacy",
"name": "Data Privacy"
},
{
"description": "events",
"name": "Events"
},
{
"description": "flows",
"name": "Flows"
},
{
"description": "forms",
"name": "Forms"
},
{
"description": "images",
"name": "Images"
},
{
"description": "lists",
"name": "Lists"
},
{
"description": "metrics",
"name": "Metrics"
},
{
"description": "profiles",
"name": "Profiles"
},
{
"description": "reporting",
"name": "Reporting"
},
{
"description": "reviews",
"name": "Reviews"
},
{
"description": "segments",
"name": "Segments"
},
{
"description": "tags",
"name": "Tags"
},
{
"description": "templates",
"name": "Templates"
},
{
"description": "tracking settings",
"name": "Tracking Settings"
},
{
"description": "web feeds",
"name": "Web Feeds"
},
{
"description": "webhooks",
"name": "Webhooks"
},
{
"description": "client",
"name": "Client"
}
],
"x-readme": {
"explorer-enabled": false,
"proxy-enabled": true,
"samples-enabled": true
}
}