{
"openapi": "3.0.2",
"info": {
"title": "Klaviyo API",
"version": "2026-10-15",
"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": {
"post": {
"operationId": "create_translation",
"summary": "Create Translation",
"description": "Create 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/stable/apis/create_translation.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-10-15/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-10-15"
}
}
],
"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": [
"Translations"
],
"x-klaviyo-pre-release": "None",
"x-klaviyo-ratelimit": {
"burst": "10/s",
"steady": "150/m"
},
"x-klaviyo-scopes": [
"translations:write"
]
}
}
},
"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"
}
}
}
},
"CampaignVariationEnum": {
"type": "string",
"enum": [
"campaign-variation"
]
},
"ConsentPageEnum": {
"type": "string",
"enum": [
"consent-page"
]
},
"FlowMessageEnum": {
"type": "string",
"enum": [
"flow-message"
]
},
"ObjectLinks": {
"type": "object",
"properties": {
"self": {
"type": "string",
"format": "uri"
}
},
"required": [
"self"
]
},
"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"
]
},
"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"
}
}
},
"TemplateEnum": {
"type": "string",
"enum": [
"template"
]
},
"TemplateUniversalContentEnum": {
"type": "string",
"enum": [
"template-universal-content"
]
},
"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"
]
}
},
"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-10-15/reference/api-overview#authentication",
"x-default": "Klaviyo-API-Key your-private-api-key"
}
}
},
"tags": [
{
"name": "Translations",
"description": "translations"
}
]
}