Dovkie
Sign in
Back to monitors

klaviyo

Klaviyo API

REST
OpenAPI (JSON)
https://raw.githubusercontent.com/klaviyo/openapi/main/openapi/stable.json
Additive AI classification

Add channel field to Conversation object and enum options

The Klaviyo API adds a new required attributes object to the Conversation resource with a required channel field that can be instagram, sms, or whatsapp. Additionally, channel is added as an optional enum value to several field filters. This change adds new response fields and makes the attributes object required in the Conversation response schema.

Alert history

  • Additive

    Add channel field to Conversation object and enum options

    The Klaviyo API adds a new required attributes object to the Conversation resource with a required channel field that can be instagram, sms, or whatsapp. Additionally, channel is added as an optional enum value to several field filters. This change adds new response fields and makes the attributes object required in the Conversation response schema.

  • Additive

    Add message_hierarchy field to push message definitions

    A new optional message_hierarchy field has been added to multiple push message definition schemas across the Klaviyo API. This field is nullable and describes an RCS/SMS message hierarchy (fallback chain) with format and content information. The change is purely additive and does not affect existing integrations.

  • Additive

    Add font_style and text_decoration fields to text properties

    Two new optional response fields—font_style and text_decoration—have been added to text styling properties in the Klaviyo API. Both fields are nullable strings and do not affect existing integrations.

  • Additive

    Add email open tracking consent fields to subscription schemas

    The Klaviyo API introduces new email open tracking consent support with a new OpenTrackingConsent schema and updates to EmailChannel, EmailSubscriptionParameters, and EmailUnsubscriptionParameters to include optional open_tracking fields. Existing integrations remain unaffected as all new fields are optional and the new schema parameters are nullable, enabling gradual adoption of open tracking consent management.

  • Informational

    Bulk catalog API rate limits updated in documentation

    Rate limit values for six catalog bulk operation endpoints have been updated from 350/s burst and 3500/m steady to 75/s burst and 750/m steady. This is a documentation change only—the actual rate limits applied by the API have changed, but the endpoint signatures, request/response formats, and SDK interfaces remain unchanged.

  • Additive

    Form Version response and query parameters expanded

    The GET /api/form-versions endpoint adds optional query parameters fields[form] and include for sparse fieldsets and relationship inclusion, plus a new included array in the response. The response schema renamed from GetFormVersionResponse to GetFormVersionResponseCompoundDocument with a new relationships.form object on form versions. Additionally, the daily rate limit for image uploads increases from 100 to 500 requests/day, and "Message Format" is added as a filter/sort option for reports.

  • Additive

    WhatsApp phone_number field now nullable, removed from required

    The phone_number field in three WhatsApp channel schemas (WhatsappTransactionalChannel, WhatsappConversationalChannel, and WhatsappChannel) is now marked nullable: true and removed from the required array. This makes the field optional and allows null values, enabling clients to omit phone numbers when the data is not available. Additionally, a documentation example for the operator field was expanded to show a complete filter usage pattern.

  • Breaking

    ProfileEventTrackedProperties.metric no longer required; new enum value added

    Two changes in this diff:

    • ProfileEventTrackedProperties.metric is removed from the required array and gains nullable: true with a default of "". Clients that previously relied on metric always being present in responses may break; servers that previously required metric in requests no longer do, which is additive for request senders but potentially breaking for consumers expecting it.
    • A new enum value "full" is added to a size/image-related field's enum (appears to be an image size selector), which is a purely additive change for that field.
  • Additive

    Add DELETE /api/flow-actions/{id} endpoint

    A new DELETE /api/flow-actions/{id} endpoint has been added to allow deletion of flow actions. This is a new optional operation that does not break existing code but provides additional functionality for managing flows.

  • Additive

    Add metric field filtering support to metrics endpoint

    The filter query parameter on the metrics endpoint now supports filtering by the metric field using the has operator. This is a purely additive change that expands filtering capabilities without removing or altering existing functionality.

  • Additive

    Add vendor_id, FlowWhatsApp, and channel fields to Klaviyo API

    Added new optional fields to the Klaviyo API: vendor_id in message definitions for flow campaigns, a new FlowWhatsApp schema type, and a channel field for form objects. Also inlined three reusable filter schemas (ActionOutputConditionFilter, MetricPropertyConditionFilter, PriceDropConditionFilter, LowInventoryConditionFilter) into their concrete usages, and added a new IafDeeplinkToScreen button type. All changes are backward-compatible expansions of the API surface.

  • Breaking

    EnrollFormAction schema and definition.data.form_id field removed

    The EnrollFormAction and EnrollFormActionData schemas have been entirely removed from the spec, along with definition.data.form_id from the allowed fields list across multiple flow endpoints. EnrollFormAction is also removed from all oneOf action union types used in flow create/update/read operations. Any client that references EnrollFormAction, uses type: "enroll-form" actions, or requests/sends definition.data.form_id will break.

  • Additive

    Add optional accessible_name field to modal properties

    A new optional accessible_name field (string, nullable) has been added to a modal properties schema. This is a purely additive change that does not affect existing integrations.

  • Additive

    Add web_url field to push notification on_open action

    The Klaviyo API now supports a new PushOnOpenWebUrl schema and adds web_url as an option in push notification's definition.options.on_open configuration. This enables opening external URLs when a push notification is triggered, extending the existing deep-link and app-open capabilities without breaking existing integrations.

  • Additive

    Add web_url field to message objects and open_url action type

    The Klaviyo API now exposes a new web_url field on message objects and introduces a new open_url action type option. Both changes are backward compatible and purely additive — existing integrations continue to work unchanged, and client applications can optionally leverage the new fields to support additional web messaging capabilities.

  • Additive

    Add channel affinity conditions and cart content segment type

    Added two new predictive analytics condition types (ProfilePredictiveAnalyticsChannelAffinityPriorityCondition and ProfilePredictiveAnalyticsChannelAffinityRankCondition) across multiple segment endpoints, a new CartContent segment condition type that consolidates cart-based properties, and new SMSDisclosureLinkTextStyle schema for SMS disclosure styling. Also removed the url field requirement from one schema (now has default value) and adjusted shadow_color enum in review block styling. These are purely additive changes that expand segment condition options without breaking existing behavior.

  • Additive

    Make form_id and list_id optional in enrollment form action

    The form_id and list_id fields in the enrollment form action request have been made optional: form_id is now nullable and both fields have been removed from the required list. This allows clients to omit these fields when creating or updating enrollment form actions, expanding the API's flexibility.

  • Breaking

    Flow action fields replaced and new trigger type added in Klaviyo API

    In the flow action schema (appears to be EnrollFormAction or similar), expire_after_unit and expire_after_value have been removed and replaced by a new required field form_id (string). This is a breaking change for any client that reads or writes these fields, and form_id is now listed as required, so existing create/update calls omitting it will fail. Additionally, a new CustomObjectDateTrigger schema has been added and included as a valid option in the flow date trigger oneOf, which is purely additive.

  • Breaking

    data field type constraints removed, now accepts any type

    The data field previously declared a oneOf constraint accepting integer, number, string, or boolean types; that constraint has been removed, leaving only nullable: true. This is a schema loosening on the spec side, but clients that relied on the documented type union for validation or code generation will now see an untyped/any field, which could break generated SDK models or strict validators expecting a known type.

  • Breaking

    Remove `data` from required fields in template universal content schema

    The field data has been removed from the required array in what appears to be a template universal content request schema. This is potentially breaking for clients that relied on server-side validation rejecting requests missing data — however, it could also be a fix making data optional, which would be additive. If clients were required to send data and the server now accepts requests without it, existing integrations are unaffected, but the change could indicate a schema correction that previously caused valid requests to fail.