{ "openapi": "3.0.2", "info": { "title": "Klaviyo API (Beta)", "version": "2026-07-15.pre", "description": "The Klaviyo REST API. Please visit https://developers.klaviyo.com for more details.", "contact": { "name": "Klaviyo Developer Experience Team", "email": "developers@klaviyo.com", "url": "https://developers.klaviyo.com" }, "termsOfService": "https://www.klaviyo.com/legal/api-terms", "license": { "name": "License", "url": "https://www.klaviyo.com/legal" } }, "servers": [ { "url": "https://a.klaviyo.com", "description": "Production" } ], "security": [ { "Klaviyo-API-Key": [] } ], "paths": { "/api/translations": { "get": { "operationId": "get_translations_beta", "summary": "Get Translations", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet all translations in an account.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`translations:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_translations_beta.json)", "parameters": [ { "name": "fields[campaign-variation]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "created", "definition", "definition.details", "definition.details.action_buttons", "definition.details.add_info_link", "definition.details.add_opt_out_language", "definition.details.add_org_prefix", "definition.details.android_deep_link", "definition.details.badge", "definition.details.badge_config", "definition.details.badge_value", "definition.details.bcc_email", "definition.details.body", "definition.details.cc_email", "definition.details.channel", "definition.details.content_available", "definition.details.cost", "definition.details.dynamic_media_template", "definition.details.from_email", "definition.details.from_label", "definition.details.include_contact_card", "definition.details.ios_deep_link", "definition.details.kv_pairs", "definition.details.message_hierarchy", "definition.details.mms_dynamic_image_template", "definition.details.mms_static_image_asset_id", "definition.details.mutable_content", "definition.details.open_action", "definition.details.preview_text", "definition.details.push_platform_target", "definition.details.push_type", "definition.details.reply_to_email", "definition.details.send_to_primary", "definition.details.shorten_links", "definition.details.sound", "definition.details.sound_file_name", "definition.details.static_asset_id", "definition.details.subject", "definition.details.template_id", "definition.details.text_message_type", "definition.details.title", "definition.details.video_asset_id", "definition.details.web_url", "definition.name", "id", "updated" ] } }, "explode": false }, { "name": "fields[flow-message]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "channel", "content", "content.action_buttons", "content.android_link", "content.badge", "content.bcc_email", "content.body", "content.cc_email", "content.dynamic_image", "content.from_email", "content.from_label", "content.ios_link", "content.media_url", "content.on_open", "content.preview_text", "content.reply_to_email", "content.sound", "content.subject", "content.title", "content.web_url", "created", "id", "name", "updated" ] } }, "explode": false }, { "name": "fields[template-universal-content]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "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" ] } }, "explode": false }, { "name": "fields[template]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "amp", "created", "editor_type", "html", "id", "name", "text", "updated" ] } }, "explode": false }, { "name": "fields[translation]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "channel", "created", "fallback_locale", "id", "metadata", "source_locale", "target_locales", "updated" ] } }, "explode": false }, { "name": "filter", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#filtering
Allowed field(s)/operator(s):
`id`: `any`, `equals` (string)
`resource_type`: `equals` (string)
`channel`: `equals` (allowed values: `'email'`, `'sms'`, `'mobile_push'`, `'whatsapp'`, `'web'`)
`related_resource_id`: `equals` (string)", "schema": { "type": "string", "example": "equals(id,'campaign-variation::email::01KH00000000000000000000AB')" } }, { "name": "include", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#relationships", "schema": { "type": "array", "items": { "type": "string", "enum": [ "campaign-variation", "flow-message", "template", "template-universal-content" ] } }, "explode": false }, { "name": "page[cursor]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#pagination", "required": false, "schema": { "type": "string" } }, { "name": "page[size]", "in": "query", "description": "Default: 20. Min: 1. Max: 100.", "required": false, "schema": { "type": "integer", "default": 20, "maximum": 100, "minimum": 1 } }, { "name": "sort", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sorting", "schema": { "type": "string", "enum": [ "id", "-id" ] } }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetTranslationListResponseCollectionCompoundDocument" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-filters": { "id": { "operators": { "list": [ "any", "equals" ], "single": [ "equals" ] }, "value": { "type": "string" } }, "resource_type": { "operators": { "single": [ "equals" ] }, "value": { "type": "string" } }, "channel": { "operators": { "single": [ "equals" ] }, "value": { "type": "string", "enum": [ "email", "sms", "mobile_push", "whatsapp", "web" ] } }, "related_resource_id": { "operators": { "single": [ "equals" ] }, "value": { "type": "string" } } }, "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "translations:read" ], "x-klaviyo-subtag": "Translations" }, "post": { "operationId": "create_translation_beta", "summary": "Create Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nCreate a translation.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`translations:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/create_translation_beta.json)", "parameters": [ { "name": "additional-fields[translation]", "in": "query", "description": "Request additional fields not included by default in the response. Supported values: 'values'", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "values" ] } }, "explode": false }, { "name": "fields[translation]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "channel", "created", "fallback_locale", "id", "metadata", "source_locale", "target_locales", "updated", "values" ] } }, "explode": false }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "requestBody": { "description": "Create a translation", "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TranslationCreateQuery" } } } }, "responses": { "201": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PostTranslationRetrieveResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "translations:write" ], "x-klaviyo-subtag": "Translations" } }, "/api/translations/{id}": { "get": { "operationId": "get_translation_beta", "summary": "Get Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet the translation with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`translations:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "additional-fields[translation]", "in": "query", "description": "Request additional fields not included by default in the response. Supported values: 'values'", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "values" ] } }, "explode": false }, { "name": "fields[campaign-variation]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "created", "definition", "definition.details", "definition.details.action_buttons", "definition.details.add_info_link", "definition.details.add_opt_out_language", "definition.details.add_org_prefix", "definition.details.android_deep_link", "definition.details.badge", "definition.details.badge_config", "definition.details.badge_value", "definition.details.bcc_email", "definition.details.body", "definition.details.cc_email", "definition.details.channel", "definition.details.content_available", "definition.details.cost", "definition.details.dynamic_media_template", "definition.details.from_email", "definition.details.from_label", "definition.details.include_contact_card", "definition.details.ios_deep_link", "definition.details.kv_pairs", "definition.details.message_hierarchy", "definition.details.mms_dynamic_image_template", "definition.details.mms_static_image_asset_id", "definition.details.mutable_content", "definition.details.open_action", "definition.details.preview_text", "definition.details.push_platform_target", "definition.details.push_type", "definition.details.reply_to_email", "definition.details.send_to_primary", "definition.details.shorten_links", "definition.details.sound", "definition.details.sound_file_name", "definition.details.static_asset_id", "definition.details.subject", "definition.details.template_id", "definition.details.text_message_type", "definition.details.title", "definition.details.video_asset_id", "definition.details.web_url", "definition.name", "id", "updated" ] } }, "explode": false }, { "name": "fields[flow-message]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "channel", "content", "content.action_buttons", "content.android_link", "content.badge", "content.bcc_email", "content.body", "content.cc_email", "content.dynamic_image", "content.from_email", "content.from_label", "content.ios_link", "content.media_url", "content.on_open", "content.preview_text", "content.reply_to_email", "content.sound", "content.subject", "content.title", "content.web_url", "created", "id", "name", "updated" ] } }, "explode": false }, { "name": "fields[template-universal-content]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "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" ] } }, "explode": false }, { "name": "fields[template]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "amp", "created", "editor_type", "html", "id", "name", "text", "updated" ] } }, "explode": false }, { "name": "fields[translation]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "channel", "created", "fallback_locale", "id", "metadata", "source_locale", "target_locales", "updated", "values" ] } }, "explode": false }, { "name": "include", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#relationships", "schema": { "type": "array", "items": { "type": "string", "enum": [ "campaign-variation", "flow-message", "template", "template-universal-content" ] } }, "explode": false }, { "name": "page_type", "in": "query", "description": "Scope returned consent-page values to a single page type. Only applies to consent-page translations.", "required": false, "schema": { "description": "Scope returned consent-page values to a single page type. Only applies to consent-page translations.", "type": "string", "enum": [ "double-opt-in-confirmation-page", "double-opt-in-email", "preference-page", "preference-success-page", "subscribe-page", "subscribe-success-page", "unsubscribe-page", "unsubscribe-success-page" ], "nullable": true } }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetTranslationRetrieveResponseCompoundDocument" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "translations:read" ], "x-klaviyo-subtag": "Translations" }, "patch": { "operationId": "update_translation_beta", "summary": "Update Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nUpdate the translation with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`translations:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/update_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "additional-fields[translation]", "in": "query", "description": "Request additional fields not included by default in the response. Supported values: 'values'", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "values" ] } }, "explode": false }, { "name": "fields[translation]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "channel", "created", "fallback_locale", "id", "metadata", "source_locale", "target_locales", "updated", "values" ] } }, "explode": false }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "requestBody": { "description": "Update a translation by ID", "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/TranslationPartialUpdateQuery" } } } }, "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PatchTranslationRetrieveResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "translations:write" ], "x-klaviyo-subtag": "Translations" }, "delete": { "operationId": "delete_translation_beta", "summary": "Delete Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nDelete the translation with the given ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`translations:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/delete_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "204": { "description": "Success" }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "translations:write" ], "x-klaviyo-subtag": "Translations" } }, "/api/translations/{id}/campaign-variation": { "get": { "operationId": "get_campaign_variation_for_translation_beta", "summary": "Get Campaign Variation for Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet the campaign variation for the given translation ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`translations:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_campaign_variation_for_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "fields[campaign-variation]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "created", "definition", "definition.details", "definition.details.action_buttons", "definition.details.add_info_link", "definition.details.add_opt_out_language", "definition.details.add_org_prefix", "definition.details.android_deep_link", "definition.details.badge", "definition.details.badge_config", "definition.details.badge_value", "definition.details.bcc_email", "definition.details.body", "definition.details.cc_email", "definition.details.channel", "definition.details.content_available", "definition.details.cost", "definition.details.dynamic_media_template", "definition.details.from_email", "definition.details.from_label", "definition.details.include_contact_card", "definition.details.ios_deep_link", "definition.details.kv_pairs", "definition.details.message_hierarchy", "definition.details.mms_dynamic_image_template", "definition.details.mms_static_image_asset_id", "definition.details.mutable_content", "definition.details.open_action", "definition.details.preview_text", "definition.details.push_platform_target", "definition.details.push_type", "definition.details.reply_to_email", "definition.details.send_to_primary", "definition.details.shorten_links", "definition.details.sound", "definition.details.sound_file_name", "definition.details.static_asset_id", "definition.details.subject", "definition.details.template_id", "definition.details.text_message_type", "definition.details.title", "definition.details.video_asset_id", "definition.details.web_url", "definition.name", "id", "updated" ] } }, "explode": false }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetVariationResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-operation-aliases": [ "get_translation_campaign_variation" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "campaigns:read", "translations:read" ], "x-klaviyo-subtag": "Translations" } }, "/api/translations/{id}/relationships/campaign-variation": { "get": { "operationId": "get_campaign_variation_id_for_translation_beta", "summary": "Get Campaign Variation ID for Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet the campaign variation for the given translation ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`campaigns:read`\n`translations:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_campaign_variation_id_for_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetTranslationCampaignVariationRelationshipResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-operation-aliases": [ "get_translation_relationships_campaign_variation" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "campaigns:read", "translations:read" ], "x-klaviyo-subtag": "Translations" } }, "/api/translations/{id}/flow-message": { "get": { "operationId": "get_flow_message_for_translation_beta", "summary": "Get Flow Message for Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet the flow message for the given translation ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`flows:read`\n`translations:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_flow_message_for_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "fields[flow-message]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "channel", "content", "content.action_buttons", "content.android_link", "content.badge", "content.bcc_email", "content.body", "content.cc_email", "content.dynamic_image", "content.from_email", "content.from_label", "content.ios_link", "content.media_url", "content.on_open", "content.preview_text", "content.reply_to_email", "content.sound", "content.subject", "content.title", "content.web_url", "created", "id", "name", "updated" ] } }, "explode": false }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetFlowMessageResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-operation-aliases": [ "get_translation_flow_message" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "flows:read", "translations:read" ], "x-klaviyo-subtag": "Translations" } }, "/api/translations/{id}/relationships/flow-message": { "get": { "operationId": "get_flow_message_id_for_translation_beta", "summary": "Get Flow Message ID for Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet the flow message for the given translation ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`flows:read`\n`translations:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_flow_message_id_for_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetTranslationFlowMessageRelationshipResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-operation-aliases": [ "get_translation_relationships_flow_message" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "flows:read", "translations:read" ], "x-klaviyo-subtag": "Translations" } }, "/api/translations/{id}/template": { "get": { "operationId": "get_template_for_translation_beta", "summary": "Get Template for Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet the template for the given translation ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`templates:read`\n`translations:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_template_for_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "fields[template]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "amp", "created", "editor_type", "html", "id", "name", "text", "updated" ] } }, "explode": false }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetTemplateResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-operation-aliases": [ "get_translation_template" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "templates:read", "translations:read" ], "x-klaviyo-subtag": "Translations" } }, "/api/translations/{id}/relationships/template": { "get": { "operationId": "get_template_id_for_translation_beta", "summary": "Get Template ID for Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet the template for the given translation ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`templates:read`\n`translations:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_template_id_for_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetTranslationTemplateRelationshipResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-operation-aliases": [ "get_translation_relationships_template" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "templates:read", "translations:read" ], "x-klaviyo-subtag": "Translations" } }, "/api/translations/{id}/template-universal-content": { "get": { "operationId": "get_template_universal_content_for_translation_beta", "summary": "Get Template Universal Content for Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet the template universal content for the given translation ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`templates:read`\n`translations:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_template_universal_content_for_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "fields[template-universal-content]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-07-15.pre/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "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" ] } }, "explode": false }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetUniversalContentResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-operation-aliases": [ "get_translation_template_universal_content" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "templates:read", "translations:read" ], "x-klaviyo-subtag": "Translations" } }, "/api/translations/{id}/relationships/template-universal-content": { "get": { "operationId": "get_template_universal_content_id_for_translation_beta", "summary": "Get Template Universal Content ID for Translation", "description": "\n > \ud83d\udea7 This endpoint is in beta and subject to change.\n >\n > A beta revision header (2026-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.\n\nGet the template universal content for the given translation ID.

*Rate limits*:
Burst: `10/s`
Steady: `150/m`\n\n**Scopes:**\n`templates:read`\n`translations:read`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/get_template_universal_content_id_for_translation_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the translation", "required": true, "schema": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" } }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-07-15.pre" } } ], "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/GetTranslationTemplateUniversalContentRelationshipResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-operation-aliases": [ "get_translation_relationships_template_universal_content" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "10/s", "steady": "150/m" }, "x-klaviyo-scopes": [ "templates:read", "translations:read" ], "x-klaviyo-subtag": "Translations" } } }, "components": { "responses": { "ClientError": { "description": "Client Error", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "title", "detail" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "type": "string" }, "parameter": { "type": "string" } } } } } } }, "required": [ "errors" ] } } } }, "ServerError": { "description": "Server Error", "content": { "application/vnd.api+json": { "schema": { "type": "object", "properties": { "errors": { "type": "array", "items": { "type": "object", "required": [ "id", "code", "title", "detail" ], "properties": { "id": { "type": "string" }, "code": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "type": "string" }, "parameter": { "type": "string" } } } } } } }, "required": [ "errors" ] } } } } }, "schemas": { "AgentHints": { "description": "Optional hints emitted by the API for agent callers", "type": "object", "properties": { "next_steps": { "description": "Suggested follow-up actions for agents to take after this response", "type": "array", "items": { "type": "string" } } } }, "BlockDisplayOptions": { "type": "object", "properties": { "show_on": { "description": "Show on.", "type": "string", "enum": [ "all", "desktop", "mobile" ], "nullable": true }, "visible_check": { "type": "string", "nullable": true }, "content_repeat": { "$ref": "#/components/schemas/ContentRepeatV0", "nullable": true } } }, "ButtonBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "button" ] }, "data": { "nullable": true } }, "required": [ "content_type", "type", "data" ] }, "CampaignMessageEnum": { "type": "string", "enum": [ "campaign-message" ] }, "CampaignVariationEnum": { "type": "string", "enum": [ "campaign-variation" ] }, "CollectionLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" }, "prev": { "type": "string", "format": "uri" }, "next": { "type": "string", "format": "uri" } }, "required": [ "self" ] }, "ConsentPageEnum": { "type": "string", "enum": [ "consent-page" ] }, "ContentRepeatV0": { "type": "object", "properties": { "repeat_for": { "type": "string" }, "item_alias": { "type": "string" } }, "required": [ "repeat_for", "item_alias" ] }, "CouponBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "coupon" ] }, "data": { "nullable": true, "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] } }, "required": [ "content_type", "type", "data" ] }, "DropShadowBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "drop_shadow" ] }, "data": { "nullable": true } }, "required": [ "content_type", "type", "data" ] }, "DynamicSMSImage": { "type": "object", "properties": { "dynamic": { "type": "boolean", "example": true, "default": true, "enum": [ true ] }, "dynamic_image_template": { "description": "Dynamic image template URL (e.g., {{product.image_url}}).", "type": "string" } }, "required": [ "dynamic_image_template" ] }, "EmailChannelDetails": { "type": "object", "properties": { "channel": { "type": "string", "example": "email", "default": "email", "enum": [ "email" ] }, "template_id": { "type": "string", "nullable": true }, "from_label": { "type": "string", "default": "" }, "from_email": { "type": "string", "default": "" }, "reply_to_email": { "type": "string", "default": "" }, "cc_email": { "type": "string", "default": "" }, "bcc_email": { "type": "string", "default": "" }, "subject": { "type": "string", "default": "" }, "preview_text": { "type": "string", "default": "" } } }, "EmailMessageContent": { "type": "object", "properties": { "subject": { "type": "string" }, "preview_text": { "type": "string" }, "from_email": { "type": "string" }, "from_label": { "type": "string" }, "reply_to_email": { "type": "string", "nullable": true }, "cc_email": { "type": "string", "nullable": true }, "bcc_email": { "type": "string", "nullable": true } }, "required": [ "subject", "preview_text", "from_email", "from_label" ] }, "FlowActionEnum": { "type": "string", "enum": [ "flow-action" ] }, "FlowMessageEnum": { "type": "string", "enum": [ "flow-message" ] }, "FlowMessageResponseObjectResource": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FlowMessageEnum" }, "id": { "type": "string" }, "attributes": { "type": "object", "properties": { "name": { "type": "string" }, "channel": { "type": "string" }, "content": { "oneOf": [ { "$ref": "#/components/schemas/EmailMessageContent" }, { "$ref": "#/components/schemas/SMSMessageContent" }, { "$ref": "#/components/schemas/MobilePushMessageContent" } ] }, "created": { "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true }, "updated": { "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true } }, "required": [ "name", "channel", "content" ] }, "relationships": { "type": "object", "properties": { "flow-action": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FlowActionEnum" }, "id": { "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateEnum" }, "id": { "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } } } }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "GetFlowMessageResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/FlowMessageResponseObjectResource" } ], "nullable": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "GetTemplateResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/TemplateResponseObjectResource" } ], "nullable": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "GetTranslationCampaignVariationRelationshipResponse": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "type": { "$ref": "#/components/schemas/CampaignVariationEnum" }, "id": { "description": "The ID of the variation", "type": "string", "example": "925e385b52fb405715f3616c337cc65c" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "GetTranslationFlowMessageRelationshipResponse": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "type": { "$ref": "#/components/schemas/FlowMessageEnum" }, "id": { "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "GetTranslationListResponseCollectionCompoundDocument": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TranslationListResponseObjectResource" } }, "links": { "$ref": "#/components/schemas/CollectionLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" }, "included": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/VariationResponseObjectResource" }, { "$ref": "#/components/schemas/FlowMessageResponseObjectResource" }, { "$ref": "#/components/schemas/TemplateResponseObjectResource" }, { "$ref": "#/components/schemas/UniversalContentResponseObjectResource" } ] } } }, "required": [ "data" ] }, "GetTranslationRetrieveResponseCompoundDocument": { "type": "object", "properties": { "data": { "allOf": [ { "properties": { "type": { "$ref": "#/components/schemas/TranslationEnum" }, "attributes": { "properties": { "values": { "description": "The translation values for this resource. Each entry contains the value block ID, its source text, and a map of target locale codes to translated strings. Only returned when requested via additional-fields[translation]=values.", "type": "array", "items": { "type": "object" }, "nullable": true } } } } }, { "$ref": "#/components/schemas/TranslationRetrieveResponseObjectResource" } ] }, "included": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/VariationResponseObjectResource" }, { "$ref": "#/components/schemas/FlowMessageResponseObjectResource" }, { "$ref": "#/components/schemas/TemplateResponseObjectResource" }, { "$ref": "#/components/schemas/UniversalContentResponseObjectResource" } ] } }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "GetTranslationTemplateRelationshipResponse": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "type": { "$ref": "#/components/schemas/TemplateEnum" }, "id": { "description": "The ID of template", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "GetTranslationTemplateUniversalContentRelationshipResponse": { "type": "object", "properties": { "data": { "type": "object", "nullable": true, "properties": { "type": { "$ref": "#/components/schemas/TemplateUniversalContentEnum" }, "id": { "description": "The ID of the universal content", "type": "string", "example": "01HWWWKAW4RHXQJCMW4R2KRYR4" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "GetUniversalContentResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/UniversalContentResponseObjectResource" } ], "nullable": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "GetVariationResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/VariationResponseObjectResource" } ], "nullable": true }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "HTMLBlockDataV0": { "type": "object", "properties": { "content": { "type": "string" }, "display_options": { "$ref": "#/components/schemas/BlockDisplayOptions" } }, "required": [ "content", "display_options" ] }, "HTMLBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "html" ] }, "data": { "$ref": "#/components/schemas/HTMLBlockDataV0" } }, "required": [ "content_type", "type", "data" ] }, "HeaderBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "header" ] }, "data": { "nullable": true, "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] } }, "required": [ "content_type", "type", "data" ] }, "HorizontalRuleBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "horizontal_rule" ] }, "data": { "nullable": true } }, "required": [ "content_type", "type", "data" ] }, "ImageAsset": { "type": "object", "properties": { "id": { "description": "The unique identifier for this image asset. Not allowed on update.", "type": "integer" }, "file_path": { "description": "The file path of the image in Klaviyo's storage.", "type": "string", "example": "images/aa1ee5c1-039e-4d20-9e98-345755214556.jpeg" }, "name": { "description": "The human-readable name of the image.", "type": "string", "example": "product-image" }, "format": { "description": "The image file format.", "type": "string", "enum": [ "gif", "jpeg", "jpg", "png", "webp" ] }, "file_size": { "description": "The size of the image file in bytes.", "type": "integer" }, "updated": { "description": "Timestamp when the image was last updated.", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00" }, "origin": { "description": "The origin/source of the image (e.g., UI, API, AI, etc.).", "type": "string", "enum": [ "ADOPTION_SMS_FORM_FROM_EMAIL_FORM", "ADOPTION_SMS_MULTI_STEP_FORM_FROM_EMAIL_FORM", "AI", "API", "APPLICATION", "CLONED", "COMPOSER", "COMPOSER_AI_EDITED", "COMPOSER_AI_GENERATED", "COMPOSER_USED_IN_KLAVIYO_OBJECT", "COMPOSER_USER_UPLOADED", "COMPOSER_WEB_SCRAPED", "INTEGRATION", "KLAVIYO", "LIBRARY", "MARKETING_AGENT", "SOCIAL_INSTAGRAM", "SOCIAL_INSTAGRAM_OVERLAID", "UI", "WEB_SCRAPE" ], "nullable": true }, "url": { "description": "The full URL to access the image.", "type": "string", "example": "https://d3k81ch9hvuctc.cloudfront.net/company/RyGRiN/images/aa1ee5c1-039e-4d20-9e98-345755214556.jpeg" }, "image_type": { "description": "The type of image (static or dynamic).", "type": "string", "enum": [ "dynamic", "static" ] }, "l10n_key": { "description": "Localization key for this image asset, if applicable.", "type": "string", "example": "sms::01KAPBZTQBAJFD5RG9NYXBWHMR::mms_static_image_asset_id", "nullable": true } }, "required": [ "id", "file_path", "name", "format", "file_size", "updated", "url", "image_type" ] }, "ImageBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "image" ] }, "data": { "nullable": true } }, "required": [ "content_type", "type", "data" ] }, "ImageEnum": { "type": "string", "enum": [ "image" ] }, "MediaAsset": { "type": "object", "properties": { "id": { "description": "The unique identifier for this media asset. Not allowed on update.", "type": "string" }, "company_id": { "description": "The company ID that owns this media.", "type": "string", "example": "RyGRiN" }, "url": { "description": "The full URL to access the media.", "type": "string", "example": "https://d3k81ch9hvuctc.cloudfront.net/company/RyGRiN/videos/01KG5BPQBSY8F12ZWTGYHPPRXC.mp4" }, "media_type": { "description": "The media type (e.g., 'video' for video assets).", "type": "string", "example": "video", "default": "video" }, "name": { "description": "The human-readable name of the media.", "type": "string", "example": "demo video.1" }, "file_size": { "description": "The size of the media file in bytes.", "type": "integer" }, "thumbnail_url": { "description": "Optional thumbnail URL for video previews in RCS cards.", "type": "string", "nullable": true }, "l10n_key": { "description": "Localization key for this media asset, if applicable.", "type": "string", "nullable": true } }, "required": [ "id", "company_id", "url", "name", "file_size" ] }, "MediaAssetReference": { "type": "object", "properties": { "static_asset_id": { "description": "Reference to a static media asset.", "type": "string", "nullable": true }, "dynamic_template": { "description": "Dynamic template (e.g. Django tags) resolving to the media URL.", "type": "string", "nullable": true }, "thumbnail": { "description": "Optional thumbnail image reference for video media.", "$ref": "#/components/schemas/SlimImageReference", "nullable": true } } }, "MessageHierarchyRcsItem": { "type": "object", "properties": { "message": { "description": "The plain text message content. Often empty for RCS when rich_content is used.", "type": "string", "default": "" }, "message_format": { "description": "The format of this message (always 'RCS' for RCS entries).", "type": "string", "example": "RCS", "default": "RCS", "enum": [ "RCS" ] }, "rich_content": { "description": "Rich content for RCS messages (cards, suggestions, etc.).", "$ref": "#/components/schemas/RCSRichContent", "nullable": true }, "extra": { "description": "Additional metadata for RCS messages. Legacy placement. This is typically used in rich_content.cards.extra.", "type": "object", "nullable": true }, "image": { "description": "Legacy top-level image reference on the RCS hierarchy row (MySQL-backed). Prefer rich_content for RCS media going forward.", "$ref": "#/components/schemas/SlimImageReference", "nullable": true } } }, "MessageHierarchySmsItem": { "type": "object", "properties": { "message": { "description": "The plain text SMS message content.", "type": "string", "example": "Check out our latest deals: https://example.com" }, "message_format": { "description": "The format of this message (always 'SMS' for SMS entries).", "type": "string", "example": "SMS", "default": "SMS", "enum": [ "SMS" ] }, "extra": { "description": "Additional metadata for SMS messages (e.g., should_use_same_content flag).", "type": "object", "nullable": true }, "image": { "description": "Image reference for MMS messages. Mutually exclusive with media.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StaticSMSImage" }, { "$ref": "#/components/schemas/DynamicSMSImage" } ] }, "media": { "description": "Video media for MMS messages as either a hydrated MediaAsset or a reference-style payload. Mutually exclusive with image.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MediaAsset" }, { "$ref": "#/components/schemas/MediaAssetReference" } ] } }, "required": [ "message" ] }, "MobilePushMessageContent": { "type": "object", "properties": { "title": { "type": "string" }, "body": { "type": "string" }, "sound": { "type": "boolean", "default": false }, "badge": { "type": "boolean", "default": false }, "media_url": { "type": "string", "nullable": true }, "dynamic_image": { "type": "string", "nullable": true }, "ios_link": { "type": "string", "nullable": true }, "android_link": { "type": "string", "nullable": true }, "web_url": { "type": "string", "nullable": true }, "on_open": { "type": "string", "example": "home", "default": "home" }, "action_buttons": { "type": "array", "items": { "$ref": "#/components/schemas/PushActionButtonDefinition" } } }, "required": [ "title", "body" ] }, "ObjectLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" } }, "required": [ "self" ] }, "PatchTranslationRetrieveResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TranslationEnum" }, "id": { "description": "The composite ID of the translation in format {resource_type}::{qualifier}::{collection_id}", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" }, "attributes": { "type": "object", "properties": { "source_locale": { "description": "The source locale for this translation", "type": "string", "example": "en" }, "target_locales": { "description": "The target locales for this translation", "type": "array", "items": { "type": "string" } }, "fallback_locale": { "description": "The fallback locale for this translation", "type": "string", "example": "en", "nullable": true }, "channel": { "description": "The channel for this translation", "type": "string", "enum": [ "email", "mobile_push", "sms", "web", "whatsapp" ] }, "metadata": { "description": "Additional metadata for this translation", "type": "object", "nullable": true }, "created": { "description": "The datetime when this translation was created", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true }, "updated": { "description": "The datetime when this translation was updated", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true }, "values": { "description": "The translation values for this resource. Each entry contains the value block ID, its source text, and a map of target locale codes to translated strings. Only returned when requested via additional-fields[translation]=values.", "type": "array", "items": { "type": "object" }, "nullable": true } }, "required": [ "source_locale", "target_locales", "channel" ] }, "relationships": { "type": "object", "properties": { "campaign-variation": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CampaignVariationEnum" }, "id": { "description": "Related Campaign Variation", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "flow-message": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FlowMessageEnum" }, "id": { "description": "Related Flow Message", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateEnum" }, "id": { "description": "Related Template", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "template-universal-content": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateUniversalContentEnum" }, "id": { "description": "Related Template Universal Content", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "consent-page": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ConsentPageEnum" }, "id": { "description": "Related Consent Page", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } } } }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "PostTranslationRetrieveResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TranslationEnum" }, "id": { "description": "The composite ID of the translation in format {resource_type}::{qualifier}::{collection_id}", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" }, "attributes": { "type": "object", "properties": { "source_locale": { "description": "The source locale for this translation", "type": "string", "example": "en" }, "target_locales": { "description": "The target locales for this translation", "type": "array", "items": { "type": "string" } }, "fallback_locale": { "description": "The fallback locale for this translation", "type": "string", "example": "en", "nullable": true }, "channel": { "description": "The channel for this translation", "type": "string", "enum": [ "email", "mobile_push", "sms", "web", "whatsapp" ] }, "metadata": { "description": "Additional metadata for this translation", "type": "object", "nullable": true }, "created": { "description": "The datetime when this translation was created", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true }, "updated": { "description": "The datetime when this translation was updated", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true }, "values": { "description": "The translation values for this resource. Each entry contains the value block ID, its source text, and a map of target locale codes to translated strings. Only returned when requested via additional-fields[translation]=values.", "type": "array", "items": { "type": "object" }, "nullable": true } }, "required": [ "source_locale", "target_locales", "channel" ] }, "relationships": { "type": "object", "properties": { "campaign-variation": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CampaignVariationEnum" }, "id": { "description": "Related Campaign Variation", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "flow-message": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FlowMessageEnum" }, "id": { "description": "Related Flow Message", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateEnum" }, "id": { "description": "Related Template", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "template-universal-content": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateUniversalContentEnum" }, "id": { "description": "Related Template Universal Content", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "consent-page": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ConsentPageEnum" }, "id": { "description": "Related Consent Page", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } } } }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" }, "meta": { "$ref": "#/components/schemas/ResponseMeta" } }, "required": [ "data" ] }, "ProductBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "product" ] }, "data": { "nullable": true, "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] } }, "required": [ "content_type", "type", "data" ] }, "PushActionButton": { "type": "object", "properties": { "label": { "type": "string" }, "action_type": { "description": "The action type for a push notification action button.", "type": "string", "enum": [ "deep_link", "dismiss", "open_app", "open_url" ] }, "url": { "type": "string", "nullable": true }, "icon": { "type": "string", "nullable": true }, "custom_action_id": { "type": "string", "nullable": true }, "ios_deep_link": { "type": "string", "nullable": true }, "android_deep_link": { "type": "string", "nullable": true } }, "required": [ "label", "action_type" ] }, "PushActionButtonDefinition": { "type": "object", "properties": { "label": { "description": "The button label (max 40 characters)", "type": "string" }, "action_type": { "description": "The action type: open_app, deep_link, open_url, or dismiss", "type": "string" }, "position": { "description": "The display order of the button (0-indexed). If omitted, inferred from the button's order in the list.", "type": "integer", "nullable": true }, "url": { "description": "URL for deep_link or open_url action types (max 2048 characters). Used as a fallback on platforms without a more specific ios_deep_link or android_deep_link.", "type": "string", "nullable": true }, "ios_deep_link": { "description": "iOS-specific URL for deep_link or open_url action types (max 2048 characters). Overrides url on iOS.", "type": "string", "nullable": true }, "android_deep_link": { "description": "Android-specific URL for deep_link or open_url action types (max 2048 characters). Overrides url on Android.", "type": "string", "nullable": true } }, "required": [ "label", "action_type" ] }, "PushChannelDetails": { "type": "object", "properties": { "channel": { "type": "string", "example": "push", "default": "push", "enum": [ "push" ] }, "title": { "type": "string", "default": "" }, "body": { "type": "string", "default": "" }, "badge": { "type": "boolean", "default": false }, "badge_config": { "description": "A push message variation's badge config.", "type": "string", "example": "increment-one", "default": "increment-one", "enum": [ "increment-one", "set-count", "set-property" ] }, "badge_value": { "type": "string", "example": "1", "default": "1" }, "sound_file_name": { "type": "string", "default": "" }, "static_asset_id": { "type": "integer", "nullable": true }, "sound": { "type": "boolean", "default": false }, "open_action": { "type": "integer", "default": 0 }, "dynamic_media_template": { "type": "string", "default": "" }, "kv_pairs": { "type": "object", "nullable": true }, "push_type": { "description": "A push message variation's push type.", "type": "string", "example": "standard", "default": "standard", "enum": [ "silent", "standard" ] }, "ios_deep_link": { "type": "string", "nullable": true }, "android_deep_link": { "type": "string", "nullable": true }, "web_url": { "type": "string", "nullable": true }, "content_available": { "type": "boolean", "nullable": true }, "mutable_content": { "type": "boolean", "nullable": true }, "video_asset_id": { "type": "string", "nullable": true }, "action_buttons": { "type": "array", "items": { "$ref": "#/components/schemas/PushActionButton" }, "nullable": true }, "push_platform_target": { "type": "integer", "nullable": true }, "send_to_primary": { "type": "boolean", "nullable": true } } }, "RCSCard": { "type": "object", "properties": { "id": { "description": "Unique identifier for this card.", "type": "string", "example": "44214e8f-a2fb-43b1-a8e1-1170715ffcfa" }, "title": { "description": "Optional title for the card. 200 characters is the rendered-length budget; the stored value may be longer because it is template-evaluated before it reaches the carrier.", "type": "string", "example": "Special Offer", "nullable": true }, "text": { "description": "The text content/description of the card. 2000 characters is the rendered-length budget; the stored value may be longer because it is template-evaluated before it reaches the carrier.", "type": "string", "example": "Check out our new collection!", "nullable": true }, "extra": { "description": "Additional card-specific metadata (e.g., product info). Optional.", "type": "object", "nullable": true }, "image": { "description": "Optional image for this card.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ImageAsset" }, { "$ref": "#/components/schemas/SlimImageReference" } ] }, "video": { "description": "Optional video for this card. May be a hydrated MediaAsset or a reference-style payload (e.g. static_asset_id), matching MMS ``MessageHierarchySmsItem.media`` behavior.", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/MediaAsset" }, { "$ref": "#/components/schemas/MediaAssetReference" } ] }, "buttons": { "description": "Optional action buttons for this card. At most 4.", "type": "array", "items": { "$ref": "#/components/schemas/RCSSuggestion" }, "nullable": true } }, "required": [ "id" ] }, "RCSRichContent": { "type": "object", "properties": { "cards": { "description": "List of cards in this rich content. At most 10.", "type": "array", "items": { "$ref": "#/components/schemas/RCSCard" }, "nullable": true }, "suggestions": { "description": "List of suggestion buttons for user interaction. At most 11.", "type": "array", "items": { "$ref": "#/components/schemas/RCSSuggestion" }, "nullable": true }, "file": { "description": "Standalone media file for RCS messages without cards.", "$ref": "#/components/schemas/MediaAssetReference", "nullable": true } } }, "RCSSuggestion": { "type": "object", "properties": { "id": { "description": "Unique identifier for this suggestion/button.", "type": "string", "example": "quick-action-1767105662671" }, "text": { "description": "The display text for the suggestion button. 25 characters is the rendered-length budget; the stored value may be longer because it is template-evaluated before it reaches the carrier.", "type": "string", "example": "Shop Now" }, "type": { "description": "The type of action this suggestion performs.", "type": "string", "enum": [ "OPEN_URL", "REPLY" ] }, "url": { "description": "The URL to open (required for OPEN_URL type).", "type": "string", "example": "https://www.example.com/shop", "nullable": true }, "open_mode": { "description": "How the URL opens on the device for OPEN_URL suggestions (browser vs webview size). Emitted to Infobip as openIn. Absent means browser.", "type": "string", "example": "WEBVIEW_FULL", "enum": [ "BROWSER", "WEBVIEW_FULL", "WEBVIEW_HALF", "WEBVIEW_TALL" ], "nullable": true } }, "required": [ "id", "text", "type" ] }, "RelationshipLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" }, "related": { "type": "string", "format": "uri" } }, "required": [ "self", "related" ] }, "ResponseMeta": { "description": "Response-level metadata", "type": "object", "properties": { "agent_hints": { "$ref": "#/components/schemas/AgentHints" } } }, "ReviewBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "review" ] }, "data": { "nullable": true, "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] } }, "required": [ "content_type", "type", "data" ] }, "SMSChannelDetails": { "type": "object", "properties": { "channel": { "type": "string", "example": "sms", "default": "sms", "enum": [ "sms" ] }, "template_id": { "type": "string", "nullable": true }, "cost": { "description": "Not allowed on create.", "type": "number", "nullable": true }, "mms_static_image_asset_id": { "type": "integer", "nullable": true }, "shorten_links": { "type": "boolean", "nullable": true }, "include_contact_card": { "type": "boolean", "nullable": true }, "body": { "type": "string", "default": "" }, "add_org_prefix": { "type": "boolean", "nullable": true }, "add_info_link": { "type": "boolean", "nullable": true }, "add_opt_out_language": { "type": "boolean", "nullable": true }, "mms_dynamic_image_template": { "type": "string", "nullable": true }, "text_message_type": { "description": "A sms message variation's text message type.\n\nValues match the Django OmniSMSTextMessageType (MESSAGE_FORMAT_*)\n constants.", "type": "string", "example": "SMS", "default": "SMS", "enum": [ "MMS", "RCS", "SMS" ] }, "message_hierarchy": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/MessageHierarchyRcsItem" }, { "$ref": "#/components/schemas/MessageHierarchySmsItem" } ] }, "nullable": true } } }, "SMSMessageContent": { "type": "object", "properties": { "body": { "type": "string" }, "media_url": { "type": "string", "nullable": true } }, "required": [ "body" ] }, "SectionV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "section" ] }, "type": { "type": "string", "enum": [ "section" ] }, "data": { "nullable": true } }, "required": [ "content_type", "type" ] }, "SlimImageReference": { "type": "object", "properties": { "static_image_asset_id": { "description": "ID of the static image asset when the card uses a library image.", "type": "integer", "nullable": true }, "dynamic_image_template": { "description": "Dynamic image template (e.g. Django tags) for the card image.", "type": "string", "nullable": true }, "rendered_asset_url": { "description": "Pre-rendered image URL when available.", "type": "string", "nullable": true } } }, "SocialBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "social" ] }, "data": { "nullable": true, "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] } }, "required": [ "content_type", "type", "data" ] }, "SpacerBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "spacer" ] }, "data": { "nullable": true } }, "required": [ "content_type", "type", "data" ] }, "SplitBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "split" ] }, "data": { "nullable": true, "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] } }, "required": [ "content_type", "type", "data" ] }, "StaticSMSImage": { "type": "object", "properties": { "dynamic": { "type": "boolean", "default": false, "enum": [ false ], "nullable": true }, "static_image_asset_id": { "description": "The ID of the static image asset to include.", "type": "integer" } }, "required": [ "static_image_asset_id" ] }, "TableBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "table" ] }, "data": { "nullable": true, "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] } }, "required": [ "content_type", "type", "data" ] }, "TemplateEnum": { "type": "string", "enum": [ "template" ] }, "TemplateResponseObjectResource": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateEnum" }, "id": { "description": "The ID of template", "type": "string" }, "attributes": { "type": "object", "properties": { "name": { "description": "The name of the template", "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" }, "text": { "description": "The template plain_text", "type": "string", "nullable": true }, "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", "type": "string", "nullable": true }, "created": { "description": "The date the template was created in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true }, "updated": { "description": "The date the template was updated in ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm)", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true } }, "required": [ "name", "editor_type", "html" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "TemplateUniversalContentEnum": { "type": "string", "enum": [ "template-universal-content" ] }, "TextBlockDataV0": { "type": "object", "properties": { "content": { "type": "string" }, "display_options": { "$ref": "#/components/schemas/BlockDisplayOptions" }, "styles": { "$ref": "#/components/schemas/TextBlockStylesV0" } }, "required": [ "content", "display_options", "styles" ] }, "TextBlockStylesV0": { "type": "object", "properties": { "background_color": { "type": "string", "nullable": true }, "block_background_color": { "type": "string", "nullable": true }, "block_border_color": { "type": "string", "nullable": true }, "block_border_style": { "description": "Border style.", "type": "string", "enum": [ "dashed", "dotted", "groove", "inset", "none", "outset", "ridge", "solid" ], "nullable": true }, "block_border_width": { "type": "integer", "nullable": true }, "block_padding_bottom": { "type": "integer", "nullable": true }, "block_padding_left": { "type": "integer", "nullable": true }, "block_padding_right": { "type": "integer", "nullable": true }, "block_padding_top": { "type": "integer", "nullable": true }, "color": { "type": "string", "nullable": true }, "extra_css_class": { "type": "string", "nullable": true }, "font_family": { "type": "string", "nullable": true }, "font_size": { "type": "integer", "nullable": true }, "font_style": { "description": "Font style.", "type": "string", "enum": [ "italic", "normal" ], "nullable": true }, "font_weight": { "type": "string", "nullable": true }, "inner_padding_bottom": { "type": "integer", "nullable": true }, "inner_padding_left": { "type": "integer", "nullable": true }, "inner_padding_right": { "type": "integer", "nullable": true }, "inner_padding_top": { "type": "integer", "nullable": true }, "letter_spacing": { "type": "integer", "nullable": true }, "line_height": { "type": "number", "nullable": true }, "mobile_stretch_content": { "type": "boolean", "nullable": true }, "text_align": { "description": "Text Alignment.", "type": "string", "enum": [ "center", "left", "right" ], "nullable": true }, "text_decoration": { "type": "string", "nullable": true }, "text_table_layout": { "description": "Text table layout.", "type": "string", "enum": [ "auto", "fixed", "inherit", "initial" ], "nullable": true } } }, "TextBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "text" ] }, "data": { "$ref": "#/components/schemas/TextBlockDataV0" } }, "required": [ "content_type", "type", "data" ] }, "TranslationCreateQuery": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TranslationCreateQueryResourceObject" } }, "required": [ "data" ] }, "TranslationCreateQueryResourceObject": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TranslationEnum" }, "attributes": { "type": "object", "properties": { "source_locale": { "description": "The source locale for this translation", "type": "string", "example": "en" }, "target_locales": { "description": "The target locales for this translation", "type": "array", "items": { "type": "string" } }, "fallback_locale": { "description": "The fallback locale for this translation", "type": "string", "example": "en" }, "channel": { "description": "The channel for this translation", "type": "string", "enum": [ "email", "mobile_push", "sms", "web", "whatsapp" ] } }, "required": [ "source_locale", "target_locales", "fallback_locale", "channel" ] }, "relationships": { "type": "object", "properties": { "campaign-variation": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CampaignVariationEnum" }, "id": { "description": "Related Campaign Variation", "type": "string" } }, "required": [ "type", "id" ] } } }, "flow-message": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FlowMessageEnum" }, "id": { "description": "Related Flow Message", "type": "string" } }, "required": [ "type", "id" ] } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateEnum" }, "id": { "description": "Related Template", "type": "string" } }, "required": [ "type", "id" ] } } }, "template-universal-content": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateUniversalContentEnum" }, "id": { "description": "Related Template Universal Content", "type": "string" } }, "required": [ "type", "id" ] } } }, "consent-page": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ConsentPageEnum" }, "id": { "description": "Related Consent Page", "type": "string" } }, "required": [ "type", "id" ] } } } } } }, "required": [ "type", "attributes" ] }, "TranslationEnum": { "type": "string", "enum": [ "translation" ] }, "TranslationListResponseObjectResource": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TranslationEnum" }, "id": { "description": "The composite ID of the translation in format {resource_type}::{qualifier}::{collection_id}", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" }, "attributes": { "type": "object", "properties": { "source_locale": { "description": "The source locale for this translation", "type": "string", "example": "en" }, "target_locales": { "description": "The target locales for this translation", "type": "array", "items": { "type": "string" } }, "fallback_locale": { "description": "The fallback locale for this translation", "type": "string", "example": "en", "nullable": true }, "channel": { "description": "The channel for this translation", "type": "string", "enum": [ "email", "mobile_push", "sms", "web", "whatsapp" ] }, "metadata": { "description": "Additional metadata for this translation", "type": "object", "nullable": true }, "created": { "description": "The datetime when this translation was created", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true }, "updated": { "description": "The datetime when this translation was updated", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true } }, "required": [ "source_locale", "target_locales", "channel" ] }, "relationships": { "type": "object", "properties": { "campaign-variation": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CampaignVariationEnum" }, "id": { "description": "Related Campaign Variation", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "flow-message": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FlowMessageEnum" }, "id": { "description": "Related Flow Message", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateEnum" }, "id": { "description": "Related Template", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "template-universal-content": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateUniversalContentEnum" }, "id": { "description": "Related Template Universal Content", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "consent-page": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ConsentPageEnum" }, "id": { "description": "Related Consent Page", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } } } }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "TranslationPartialUpdateQuery": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TranslationPartialUpdateQueryResourceObject" } }, "required": [ "data" ] }, "TranslationPartialUpdateQueryResourceObject": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TranslationEnum" }, "id": { "description": "The ID of the translation", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" }, "attributes": { "type": "object", "properties": { "source_locale": { "description": "The source locale for this translation", "type": "string", "example": "en", "nullable": true }, "target_locales": { "description": "The target locales for this translation", "type": "array", "items": { "type": "string" }, "nullable": true }, "fallback_locale": { "description": "The fallback locale for this translation", "type": "string", "example": "en", "nullable": true }, "values": { "description": "Translation values to import. Each object requires an ``id`` (the value block identifier from GET with additional-fields[translation]=values) and a ``translations`` map of target locale codes to translated strings.", "type": "array", "items": { "type": "object" }, "nullable": true } } } }, "required": [ "type", "id", "attributes" ] }, "TranslationRetrieveResponseObjectResource": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TranslationEnum" }, "id": { "description": "The composite ID of the translation in format {resource_type}::{qualifier}::{collection_id}", "type": "string", "example": "campaign-variation::email::01KH00000000000000000000AB" }, "attributes": { "type": "object", "properties": { "source_locale": { "description": "The source locale for this translation", "type": "string", "example": "en" }, "target_locales": { "description": "The target locales for this translation", "type": "array", "items": { "type": "string" } }, "fallback_locale": { "description": "The fallback locale for this translation", "type": "string", "example": "en", "nullable": true }, "channel": { "description": "The channel for this translation", "type": "string", "enum": [ "email", "mobile_push", "sms", "web", "whatsapp" ] }, "metadata": { "description": "Additional metadata for this translation", "type": "object", "nullable": true }, "created": { "description": "The datetime when this translation was created", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true }, "updated": { "description": "The datetime when this translation was updated", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00", "nullable": true } }, "required": [ "source_locale", "target_locales", "channel" ] }, "relationships": { "type": "object", "properties": { "campaign-variation": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CampaignVariationEnum" }, "id": { "description": "Related Campaign Variation", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "flow-message": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/FlowMessageEnum" }, "id": { "description": "Related Flow Message", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "template": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateEnum" }, "id": { "description": "Related Template", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "template-universal-content": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateUniversalContentEnum" }, "id": { "description": "Related Template Universal Content", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "consent-page": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ConsentPageEnum" }, "id": { "description": "Related Consent Page", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } } } }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "UniversalContentResponseObjectResource": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TemplateUniversalContentEnum" }, "id": { "description": "The ID of the universal content", "type": "string", "example": "01HWWWKAW4RHXQJCMW4R2KRYR4" }, "attributes": { "type": "object", "properties": { "name": { "description": "The name for this universal content", "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" } ] }, "created": { "description": "The datetime when this universal content was created", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00" }, "updated": { "description": "The datetime when this universal content was updated", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00" }, "screenshot_status": { "description": "The status of a universal content screenshot.", "type": "string", "enum": [ "completed", "failed", "generating", "never_generated", "not_renderable", "stale" ] }, "screenshot_url": { "type": "string" } }, "required": [ "name", "created", "updated", "screenshot_status", "screenshot_url" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "UnsupportedBlock": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "unsupported" ] }, "data": { "nullable": true, "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] } }, "required": [ "content_type", "type", "data" ] }, "VariationDefinition": { "type": "object", "properties": { "name": { "description": "The name of the variation", "type": "string", "nullable": true }, "details": { "description": "The channel-specific content details for this variation", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/EmailChannelDetails" }, { "$ref": "#/components/schemas/SMSChannelDetails" }, { "$ref": "#/components/schemas/PushChannelDetails" }, { "$ref": "#/components/schemas/WhatsappChannelDetails" } ] } } }, "VariationResponseObjectResource": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CampaignVariationEnum" }, "id": { "description": "The ID of the variation", "type": "string", "example": "925e385b52fb405715f3616c337cc65c" }, "attributes": { "type": "object", "properties": { "created": { "description": "The datetime when this variation was created", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00" }, "updated": { "description": "The datetime when this variation was updated", "type": "string", "format": "date-time", "example": "2022-11-08T00:00:00+00:00" }, "definition": { "description": "The definition of this variation", "$ref": "#/components/schemas/VariationDefinition" } }, "required": [ "created", "updated", "definition" ] }, "relationships": { "type": "object", "properties": { "campaign-message": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CampaignMessageEnum" }, "id": { "description": "Related Campaign Message", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "translation": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TranslationEnum" }, "id": { "description": "Related Translation", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } }, "image": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ImageEnum" }, "id": { "description": "The associated static image for mobile push variations", "type": "string" } }, "required": [ "type", "id" ] }, "links": { "$ref": "#/components/schemas/RelationshipLinks" } } } } }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "VideoBlockV0": { "type": "object", "properties": { "content_type": { "type": "string", "enum": [ "block" ] }, "type": { "type": "string", "enum": [ "video" ] }, "data": { "nullable": true, "oneOf": [ { "type": "integer" }, { "type": "number" }, { "type": "string" }, { "type": "boolean" } ] } }, "required": [ "content_type", "type", "data" ] }, "WhatsappChannelDetails": { "type": "object", "properties": { "channel": { "type": "string", "example": "whatsapp", "default": "whatsapp", "enum": [ "whatsapp" ] }, "template_id": { "type": "string", "nullable": true }, "shorten_links": { "type": "boolean", "example": true, "default": true } } } }, "securitySchemes": { "Klaviyo-API-Key": { "type": "apiKey", "in": "header", "name": "Authorization", "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-07-15.pre/reference/api-overview#authentication", "x-default": "Klaviyo-API-Key your-private-api-key" } } }, "tags": [ { "name": "Beta APIs", "description": "beta apis" } ] }