{ "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/brand-logos/{id}": { "patch": { "operationId": "update_brand_logo_beta", "summary": "Update Brand Logo", "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 brand logo with the given ID.

*Rate limits*:
Burst: `3/s`
Steady: `60/m`\n\n**Scopes:**\n`brands:write`\n\n[OpenAPI Spec](https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/beta/apis/update_brand_logo_beta.json)", "parameters": [ { "name": "id", "in": "path", "description": "The ID of the brand logo.", "required": true, "schema": { "description": "The ID of the brand logo.", "type": "string", "example": "42" } }, { "name": "fields[brand-logo]", "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": [ "alt_text", "height", "id", "link_url", "name", "width" ] } }, "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": "PATCH /api/brand-logos/{id} \u2014 JSON:API field-level partial update.\n\nPer https://jsonapi.org/format/#crud-updating-resource-attributes, only\nthe top-level attributes/relationships present in the request body are\nreplaced; missing top-level fields are preserved. A client can patch\njust `name` without disturbing `width`, `alt_text`, the `image`\nrelationship, etc.\n\nA present top-level field is replaced wholesale (no recursive merge\ninto nested structures), so sending `\"alt_text\": null` clears it.\n\nThe `image` relationship is optional on PATCH \u2014 omit to keep the\nexisting image; include with a non-null `data` to repoint at a\ndifferent image. A logo *must* have an image, so the JSON:API\n\"unlink\" form (`\"image\": {\"data\": null}`) is not supported and is\ntreated the same as omitting the relationship (existing image\npreserved).", "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/BrandLogoPartialUpdateQuery" } } } }, "responses": { "200": { "description": "Success", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/PatchBrandLogoResponse" } } } }, "4XX": { "$ref": "#/components/responses/ClientError" }, "5XX": { "$ref": "#/components/responses/ServerError" } }, "tags": [ "Beta APIs" ], "x-klaviyo-pre-release": "BETA", "x-klaviyo-ratelimit": { "burst": "3/s", "steady": "60/m" }, "x-klaviyo-scopes": [ "brands:write" ], "x-klaviyo-subtag": "Brands" } } }, "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" } } } }, "BrandLogoEnum": { "type": "string", "enum": [ "brand-logo" ] }, "BrandLogoPartialUpdateQuery": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BrandLogoPartialUpdateQueryResourceObject" } }, "required": [ "data" ] }, "BrandLogoPartialUpdateQueryResourceObject": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BrandLogoEnum" }, "id": { "description": "The ID of the brand logo.", "type": "string", "example": "42" }, "attributes": { "type": "object", "properties": { "width": { "type": "integer", "nullable": true }, "height": { "type": "integer", "nullable": true }, "alt_text": { "type": "string", "nullable": true }, "link_url": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } } }, "relationships": { "type": "object", "properties": { "image": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ImageEnum" }, "id": { "type": "string" } }, "required": [ "type", "id" ] } } } } } }, "required": [ "type", "id", "attributes" ] }, "ImageEnum": { "type": "string", "enum": [ "image" ] }, "ObjectLinks": { "type": "object", "properties": { "self": { "type": "string", "format": "uri" } }, "required": [ "self" ] }, "PatchBrandLogoResponse": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/BrandLogoEnum" }, "id": { "description": "The ID of the brand logo.", "type": "string", "example": "42" }, "attributes": { "type": "object", "properties": { "width": { "description": "Rendered width in pixels.", "type": "integer", "example": 200, "nullable": true }, "height": { "description": "Rendered height in pixels.", "type": "integer", "example": 60, "nullable": true }, "alt_text": { "description": "Accessibility alt-text for screen readers.", "type": "string", "example": "Company logo", "nullable": true }, "link_url": { "description": "Destination URL when the logo is clicked in an email.", "type": "string", "example": "https://example.com", "nullable": true }, "name": { "description": "Human-readable name for this logo.", "type": "string", "example": "Main logo", "nullable": true } } }, "relationships": { "type": "object", "properties": { "image": { "type": "object", "properties": { "data": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ImageEnum" }, "id": { "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" } } } }, "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" } ] }