{ "openapi": "3.0.2", "info": { "title": "Klaviyo API", "version": "2026-04-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/data-sources": { "post": { "operationId": "create_data_source", "summary": "Create Data Source", "description": "Create a new data source in an account

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`custom-objects:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable/apis/create_data_source.json)", "parameters": [ { "name": "fields[data-source]", "in": "query", "description": "For more information please visit https://developers.klaviyo.com/en/v2026-04-15/reference/api-overview#sparse-fieldsets", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "description", "id", "namespace", "title", "visibility" ] } }, "explode": false }, { "name": "revision", "in": "header", "description": "API endpoint revision (format: YYYY-MM-DD[.suffix])", "required": true, "schema": { "type": "string", "default": "2026-04-15" } } ], "requestBody": { "description": "Create data source", "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/DataSourceCreateQuery" } } } }, "responses": { "201": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PostDataSourceResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Custom Objects" ], "x-klaviyo-pre-release": "None", "x-klaviyo-ratelimit": { "burst": "3/s", "steady": "60/m" }, "x-klaviyo-scopes": [ "custom-objects: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": { "DataSourceCreateQuery": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DataSourceCreateQueryResourceObject" } }, "required": [ "data" ] }, "DataSourceCreateQueryResourceObject": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DataSourceEnum" }, "attributes": { "type": "object", "properties": { "title": { "description": "The title of the data source. Must be between 1 and 255 characters and unique within the namespace.", "type": "string" }, "visibility": { "description": "Visibility of data source.", "type": "string", "example": "private", "default": "private", "enum": [ "private", "shared" ], "nullable": true }, "description": { "type": "string", "default": "", "nullable": true }, "namespace": { "description": "The namespace of the data source.", "type": "string", "example": "custom-objects", "default": "custom-objects", "nullable": true } }, "required": [ "title" ] } }, "required": [ "type", "attributes" ] }, "DataSourceEnum": { "type": "string", "enum": [ "data-source" ] }, "ObjectLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" } }, "required": [ "self" ] }, "PostDataSourceResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DataSourceEnum" }, "id": { "description": "The ID of the data source", "type": "string", "example": "01KH1D6P9Y8TJ7Q6MHXWZMPDN3" }, "attributes": { "type": "object", "properties": { "title": { "description": "The title of the data source", "type": "string", "example": "My Data Source" }, "visibility": { "description": "The status of the data source", "type": "string", "enum": [ "private", "shared" ] }, "description": { "description": "The description of the data source", "type": "string", "example": "This is a data source" }, "namespace": { "description": "The namespace of the data source", "type": "string", "example": "custom-objects" } }, "required": [ "title", "visibility", "description", "namespace" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "type", "id", "attributes", "links" ] }, "links": { "$ref": "#/components/schemas/ObjectLinks" } }, "required": [ "data" ] } }, "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-04-15/reference/api-overview#authentication", "x-default": "Klaviyo-API-Key your-private-api-key" } } }, "tags": [ { "name": "Custom Objects", "description": "custom objects" } ] }