Klaviyo

klaviyo

Klaviyo is a data-driven email and SMS marketing platform that allows e-commerce brands to deliver targeted messages, track conversions, and scale customer relationships

Marketing Automation Email Newsletters Web del proveedor

Acciones

231

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (231)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Profile to ListKLAVIYO_ADD_PROFILE_TO_LISTAcción

Add profiles to a klaviyo list by profile ids or email addresses. this action subscribes profiles to a marketing list, which is ideal for giving marketing consent. you can add up to 1000 profiles per call using either their klaviyo profile ids or email addresses. rate limits: 10/s burst, 150/m steady. required scopes: `lists:write` and `profiles:write`. preconditions: - either profile ids or emails must be provided (not both) - maximum 1000 profiles per call - email addresses must be valid format - the list must exist and be accessible

Parámetros de entrada

emailsstring[]
List of email addresses to add to the list (alternative to profile_ids)
list_idstringObligatorio
The ID of the list to add profiles to
profile_idsstring[]
List of profile IDs to add to the list (max 1000 per call)

Parámetros de salida

dataobjectObligatorio
Response data from Klaviyo containing information about the operation
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Assign campaign message templateKLAVIYO_ASSIGN_CAMPAIGN_MESSAGE_TEMPLATEAcción

Creates a non-reusable version of the template and assigns it to the message. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Parámetros de entrada

data__idstring
The message ID to be assigned to
data__typestringenum
Type
campaign-message
data__relationships__template__data__idstring
The template ID to assign
data__relationships__template__data__typestringenum
Type
template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bulk create client eventsKLAVIYO_BULK_CREATE_CLIENT_EVENTSAcción

Use the client-side endpoint with a public api key to track profile activity. it accepts up to 1000 events/request with rates of 10/s burst and 150/m steady. for server-side, use the bulk create event endpoint.

Parámetros de entrada

company_idstringObligatorio
Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
data__typestringenum
Type
event-bulk-create
data__attributes__events__dataobject[]
Data
data__attributes__profile__data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__attributes__profile__data__typestringenum
Type
profile
data__attributes__profile__data__attributes____kxstring
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
data__attributes__profile__data__attributes__emailstring
Individual"s email address
data__attributes__profile__data__attributes__imagestring
URL pointing to the location of a profile image
data__attributes__profile__data__attributes__titlestring
Individual"s job title
data__attributes__profile__data__attributes__last__namestring
Individual"s last name
data__attributes__profile__data__attributes__first__namestring
Individual"s first name
data__attributes__profile__data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__profile__data__attributes__location__ipstring
IP Address
data__attributes__profile__data__attributes__organizationstring
Name of the company or organization within the company for whom the individual works
data__attributes__profile__data__attributes__anonymous__idstring
Anonymous Id
data__attributes__profile__data__attributes__location__zipstring
Zip code
data__attributes__profile__data__attributes__phone__numberstring
Individual"s phone number in E.164 format
data__attributes__profile__data__attributes__location__citystring
City name
data__attributes__profile__data__attributes__location__regionstring
Region within a country, such as state or province
data__attributes__profile__data__attributes__location__countrystring
Country name
data__attributes__profile__data__attributes__location__address1string
First line of street address
data__attributes__profile__data__attributes__location__address2string
Second line of street address
data__attributes__profile__data__attributes__location__latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__location__timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
data__attributes__profile__data__meta__patch__properties__unsetstring[]
Remove a key or keys (and their values) completely from properties
data__attributes__profile__data__attributes__location__longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Bulk create eventsKLAVIYO_BULK_CREATE_EVENTSAcción

This api endpoint creates or updates profiles by batching up to 1,000 events, with a 5mb payload limit. minimum required: a profile id and metric name. it has rate limits of 10 events per second burst and 150 events per minute. scope is `events:write`.

Parámetros de entrada

data__typestringenum
Type
event-bulk-create-job
data__attributes__events__bulk__create__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create back in stock subscriptionKLAVIYO_CREATE_BACK_IN_STOCK_SUBSCRIPTIONAcción

Use the server-side endpoint to subscribe to restock alerts, following the back in stock api guide. for client-side, use the post endpoint provided. rate limits: 350/s burst and 3500/m steady. required scopes: catalogs:write, profiles:write.

Parámetros de entrada

data__typestringenum
Type
back-in-stock-subscription
data__attributes__channelsstring[]
The channel(s) through which the profile would like to receive the back in stock notification. This can be leveraged within a back in stock flow to notify the subscriber through their preferred channel(s).
data__attributes__profile__data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__attributes__profile__data__typestringenum
Type
profile
data__relationships__variant__data__idstring
The catalog variant ID for which the profile is subscribing to back in stock notifications. This ID is made up of the integration type, catalog ID, and and the external ID of the variant like so: `integrationType:::catalogId:::externalId`. If the integration you are using is not set up for multi-catalog storage, the "catalogId" will be `$default`. For Shopify `$shopify:::$default:::33001893429341`
data__relationships__variant__data__typestringenum
Type
catalog-variant
data__attributes__profile__data__attributes__emailstring
Individual"s email address
data__attributes__profile__data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__profile__data__attributes__anonymous__idstring
Anonymous Id
data__attributes__profile__data__attributes__phone__numberstring
Individual"s phone number in E.164 format

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create campaignKLAVIYO_CREATE_CAMPAIGNAcción

Creates a campaign given a set of parameters, then returns it. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Parámetros de entrada

data__typestringenum
Type
campaign
data__attributes__namestring
The campaign name
data__attributes__send__optionsobject
Options to use when sending a campaign
data__attributes__tracking__optionsobject
The tracking options associated with the campaign
data__attributes__audiences__excludedstring[]
An optional list of excluded audiences
data__attributes__audiences__includedstring[]
A list of included audiences
data__attributes__send__strategy__methodstring
Describes the shape of the options object. Allowed values: ["static", "throttled", "immediate", "smart_send_time"]
data__attributes__campaign__messages__dataobject[]
Data
data__attributes__send__strategy__options__sto__datestringdate
The day to send on
data__attributes__send__strategy__options__static__datetimestringdate-time
The time to send at
data__attributes__send__strategy__options__static__is__localboolean
If the campaign should be sent with local recipient timezone send (requires UTC time) or statically sent at the given time. Defaults to False.
data__attributes__send__strategy__options__throttled__datetimestringdate-time
The time to send at
data__attributes__send__strategy__options__throttled__throttle__percentageinteger
The percentage of recipients per hour to send to. Allowed values: [10, 11, 13, 14, 17, 20, 25, 33, 50]
data__attributes__send__strategy__options__static__send__past__recipients__immediatelyboolean
Determines if we should send to local recipient timezone if the given time has passed. Only applicable to local sends. Defaults to False.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create campaign cloneKLAVIYO_CREATE_CAMPAIGN_CLONEAcción

Clones an existing campaign, returning a new campaign based on the original with a new id and name. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Parámetros de entrada

data__idstring
The campaign ID to be cloned
data__typestringenum
Type
campaign
data__attributes__new__namestring
The name for the new cloned campaign

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Campaign Recipient Estimation JobKLAVIYO_CREATE_CAMPAIGN_RECIPIENT_ESTIMATION_JOBAcción

Start an asynchronous task to estimate the number of recipients for a campaign. this action creates a background job that calculates how many profiles would receive the campaign based on its current audience settings. use the job id returned to track progress with the 'get campaign recipient estimation job' action, and get the final count via 'get campaign recipient estimation' action. rate limits: 10/s burst, 150/m steady. required scope: `campaigns:write`. preconditions: - valid api key with campaigns:write scope - campaign id must exist and be accessible - campaign must have audience settings configured

Parámetros de entrada

campaign_idstringObligatorio
The ID of the campaign to perform recipient estimation for

Parámetros de salida

dataobjectObligatorio
Job data from Klaviyo containing the estimation job ID and status
errorstring
Error if any occurred during the execution of the action
job_idstring
The ID of the created estimation job for tracking
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create campaign send jobKLAVIYO_CREATE_CAMPAIGN_SEND_JOBAcción

Trigger a campaign to send asynchronously *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Parámetros de entrada

data__idstring
The ID of the campaign to send
data__typestringenum
Type
campaign-send-job

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create catalog categoryKLAVIYO_CREATE_CATALOG_CATEGORYAcción

Create a new catalog category. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

data__typestringenum
Type
catalog-category
data__attributes__namestring
The name of the catalog category.
data__attributes__external__idstring
The ID of the catalog category in an external system.
data__attributes__catalog__typestring
The type of catalog. Currently only "$default" is supported.
data__relationships__items__dataobject[]
Data
data__attributes__integration__typestringenum
The integration type. Currently only "$custom" is supported.
$custom

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create catalog category relationships itemsKLAVIYO_CREATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSAcción

Create a new item relationship for the given category id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create catalog itemKLAVIYO_CREATE_CATALOG_ITEMAcción

Create a new catalog item. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

data__typestringenum
Type
catalog-item
data__attributes__urlstring
URL pointing to the location of the catalog item on your website.
data__attributes__priceinteger
This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).
data__attributes__titlestring
The title of the catalog item.
data__attributes__imagesstring[]
List of URLs pointing to the locations of images of the catalog item.
data__attributes__publishedboolean
Boolean value indicating whether the catalog item is published.
data__attributes__descriptionstring
A description of the catalog item.
data__attributes__external__idstring
The ID of the catalog item in an external system.
data__attributes__catalog__typestring
The type of catalog. Currently only "$default" is supported.
data__attributes__image__full__urlstring
URL pointing to the location of a full image of the catalog item.
data__attributes__integration__typestringenum
The integration type. Currently only "$custom" is supported.
$custom
data__relationships__categories__dataobject[]
Data
data__attributes__image__thumbnail__urlstring
URL pointing to the location of an image thumbnail of the catalog item

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create catalog item relationships categoriesKLAVIYO_CREATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESAcción

Create a new catalog category relationship for the given item id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create catalog variantKLAVIYO_CREATE_CATALOG_VARIANTAcción

Create a new variant for a related catalog item. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

data__typestringenum
Type
catalog-variant
data__attributes__skustring
The SKU of the catalog item variant.
data__attributes__urlstring
URL pointing to the location of the catalog item variant on your website.
data__attributes__priceinteger
This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).
data__attributes__titlestring
The title of the catalog item variant.
data__attributes__imagesstring[]
List of URLs pointing to the locations of images of the catalog item variant.
data__attributes__publishedboolean
Boolean value indicating whether the catalog item variant is published.
data__attributes__descriptionstring
A description of the catalog item variant.
data__attributes__external__idstring
The ID of the catalog item variant in an external system.
data__attributes__catalog__typestring
The type of catalog. Currently only "$default" is supported.
data__attributes__image__full__urlstring
URL pointing to the location of a full image of the catalog item variant.
data__attributes__integration__typestringenum
The integration type. Currently only "$custom" is supported.
$custom
data__attributes__inventory__policyinteger
This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.
data__relationships__item__data__idstring
The original catalog item ID for which this is a variant.
data__attributes__inventory__quantityinteger
The quantity of the catalog item variant currently in stock.
data__relationships__item__data__typestringenum
Type
catalog-item
data__attributes__image__thumbnail__urlstring
URL pointing to the location of an image thumbnail of the catalog item variant.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create client back in stock subscriptionKLAVIYO_CREATE_CLIENT_BACK_IN_STOCK_SUBSCRIPTIONAcción

Use the endpoint for client-side back in stock notifications with a public api key. for server-side, use post /api/back-in-stock-subscriptions. limits are 350 requests per second and 3500 per minute. requires 'catalogs:write' and 'profiles:write' scopes.

Parámetros de entrada

company_idstringObligatorio
Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
data__typestringenum
Type
back-in-stock-subscription
data__attributes__channelsstring[]
The channel(s) through which the profile would like to receive the back in stock notification. This can be leveraged within a back in stock flow to notify the subscriber through their preferred channel(s).
data__attributes__profile__data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__attributes__profile__data__typestringenum
Type
profile
data__relationships__variant__data__idstring
The catalog variant ID for which the profile is subscribing to back in stock notifications. This ID is made up of the integration type, catalog ID, and and the external ID of the variant like so: `integrationType:::catalogId:::externalId`. If the integration you are using is not set up for multi-catalog storage, the "catalogId" will be `$default`. For Shopify `$shopify:::$default:::33001893429341`
data__relationships__variant__data__typestringenum
Type
catalog-variant
data__attributes__profile__data__attributes__emailstring
Individual"s email address
data__attributes__profile__data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__profile__data__attributes__anonymous__idstring
Anonymous Id
data__attributes__profile__data__attributes__phone__numberstring
Individual"s phone number in E.164 format

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create client eventKLAVIYO_CREATE_CLIENT_EVENTAcción

Create client-side events to track profiles using a public api key, not for updating identifiers (server-side only). rate limits: 350/s, 3500/m. use `events:write` scope.

Parámetros de entrada

company_idstringObligatorio
Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
data__typestringenum
Type
event
data__attributes__timestringdate-time
When this event occurred. By default, the time the request was received will be used. The time is truncated to the second. The time must be after the year 2000 and can only be up to 1 year in the future.
data__attributes__valueinteger
A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.
data__attributes__unique__idstring
A unique identifier for an event. If the unique_id is repeated for the same profile and metric, only the first processed event will be recorded. If this is not present, this will use the time to the second. Using the default, this limits only one event per profile per second.
data__attributes__value__currencystring
The ISO 4217 currency code of the value associated with the event.
data__attributes__profile__data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__attributes__metric__data__typestringenum
Type
metric
data__attributes__profile__data__typestringenum
Type
profile
data__attributes__metric__data__attributes__namestring
Name of the event. Must be less than 128 characters.
data__attributes__profile__data__attributes____kxstring
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
data__attributes__profile__data__attributes__emailstring
Individual"s email address
data__attributes__profile__data__attributes__imagestring
URL pointing to the location of a profile image
data__attributes__profile__data__attributes__titlestring
Individual"s job title
data__attributes__metric__data__attributes__servicestring
This is for advanced usage. For api requests, this should use the default, which is set to api.
data__attributes__profile__data__attributes__last__namestring
Individual"s last name
data__attributes__profile__data__attributes__first__namestring
Individual"s first name
data__attributes__profile__data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__profile__data__attributes__location__ipstring
IP Address
data__attributes__profile__data__attributes__organizationstring
Name of the company or organization within the company for whom the individual works
data__attributes__profile__data__attributes__anonymous__idstring
Anonymous Id
data__attributes__profile__data__attributes__location__zipstring
Zip code
data__attributes__profile__data__attributes__phone__numberstring
Individual"s phone number in E.164 format
data__attributes__profile__data__attributes__location__citystring
City name
data__attributes__profile__data__attributes__location__regionstring
Region within a country, such as state or province
data__attributes__profile__data__attributes__location__countrystring
Country name
data__attributes__profile__data__attributes__location__address1string
First line of street address
data__attributes__profile__data__attributes__location__address2string
Second line of street address
data__attributes__profile__data__attributes__location__latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__location__timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
data__attributes__profile__data__attributes__location__longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__meta__patch__properties__unsetstring[]
Remove a key or keys (and their values) completely from properties

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create client subscriptionKLAVIYO_CREATE_CLIENT_SUBSCRIPTIONAcción

Endpoint manages email/sms opt-ins using consent and requires public api key for client use. allows single-channel with details. rate limit: 100/s burst, 700/m steady, under 'subscriptions:write'.

Parámetros de entrada

company_idstringObligatorio
Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
data__typestringenum
Type
subscription
data__attributes__custom__sourcestring
A custom method detail or source to store on the consent records for this subscription.
data__attributes__profile__data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__relationships__list__data__idstring
The list ID to add the newly subscribed profile to.
data__attributes__profile__data__typestringenum
Type
profile
data__relationships__list__data__typestringenum
Type
list
data__attributes__profile__data__attributes____kxstring
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
data__attributes__profile__data__attributes__emailstring
Individual"s email address
data__attributes__profile__data__attributes__imagestring
URL pointing to the location of a profile image
data__attributes__profile__data__attributes__titlestring
Individual"s job title
data__attributes__profile__data__attributes__last__namestring
Individual"s last name
data__attributes__profile__data__attributes__first__namestring
Individual"s first name
data__attributes__profile__data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__profile__data__attributes__location__ipstring
IP Address
data__attributes__profile__data__attributes__organizationstring
Name of the company or organization within the company for whom the individual works
data__attributes__profile__data__attributes__anonymous__idstring
Id that can be used to identify a profile when other identifiers are not available
data__attributes__profile__data__attributes__location__zipstring
Zip code
data__attributes__profile__data__attributes__phone__numberstring
Individual"s phone number in E.164 format
data__attributes__profile__data__attributes__location__citystring
City name
data__attributes__profile__data__attributes__location__regionstring
Region within a country, such as state or province
data__attributes__profile__data__attributes__location__countrystring
Country name
data__attributes__profile__data__attributes__location__address1string
First line of street address
data__attributes__profile__data__attributes__location__address2string
Second line of street address
data__attributes__profile__data__attributes__location__latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__location__timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
data__attributes__profile__data__meta__patch__properties__unsetstring[]
Remove a key or keys (and their values) completely from properties
data__attributes__profile__data__attributes__location__longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create couponKLAVIYO_CREATE_COUPONAcción

Creates a new coupon. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `coupons:write`

Parámetros de entrada

data__typestringenum
Type
coupon
data__attributes__descriptionstring
A description of the coupon.
data__attributes__external__idstring
This is the id that is stored in an integration such as Shopify or Magento.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create coupon codeKLAVIYO_CREATE_COUPON_CODEAcción

Synchronously creates a coupon code for the given coupon. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `coupon-codes:write`

Parámetros de entrada

data__typestringenum
Type
coupon-code
data__attributes__expires__atstringdate-time
The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.
data__attributes__unique__codestring
This is a unique string that will be or is assigned to each customer/profile and is associated with a coupon.
data__relationships__coupon__data__idstring
Id
data__relationships__coupon__data__typestringenum
Type
coupon

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create eventKLAVIYO_CREATE_EVENTAcción

Create or update a profile event with minimum identifiers and metric name. success means validation, not completion. burst limit: 350/s, steady: 3500/m. scope required: `events:write`.

Parámetros de entrada

data__typestringenum
Type
event
data__attributes__timestringdate-time
When this event occurred. By default, the time the request was received will be used. The time is truncated to the second. The time must be after the year 2000 and can only be up to 1 year in the future.
data__attributes__valueinteger
A numeric, monetary value to associate with this event. For example, the dollar amount of a purchase.
data__attributes__unique__idstring
A unique identifier for an event. If the unique_id is repeated for the same profile and metric, only the first processed event will be recorded. If this is not present, this will use the time to the second. Using the default, this limits only one event per profile per second.
data__attributes__value__currencystring
The ISO 4217 currency code of the value associated with the event.
data__attributes__profile__data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__attributes__metric__data__typestringenum
Type
metric
data__attributes__profile__data__typestringenum
Type
profile
data__attributes__metric__data__attributes__namestring
Name of the event. Must be less than 128 characters.
data__attributes__profile__data__attributes____kxstring
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
data__attributes__profile__data__attributes__emailstring
Individual"s email address
data__attributes__profile__data__attributes__imagestring
URL pointing to the location of a profile image
data__attributes__profile__data__attributes__titlestring
Individual"s job title
data__attributes__metric__data__attributes__servicestring
This is for advanced usage. For api requests, this should use the default, which is set to api.
data__attributes__profile__data__attributes__last__namestring
Individual"s last name
data__attributes__profile__data__attributes__first__namestring
Individual"s first name
data__attributes__profile__data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__profile__data__attributes__location__ipstring
IP Address
data__attributes__profile__data__attributes__organizationstring
Name of the company or organization within the company for whom the individual works
data__attributes__profile__data__attributes__anonymous__idstring
Anonymous Id
data__attributes__profile__data__attributes__location__zipstring
Zip code
data__attributes__profile__data__attributes__phone__numberstring
Individual"s phone number in E.164 format
data__attributes__profile__data__attributes__location__citystring
City name
data__attributes__profile__data__attributes__location__regionstring
Region within a country, such as state or province
data__attributes__profile__data__attributes__location__countrystring
Country name
data__attributes__profile__data__attributes__location__address1string
First line of street address
data__attributes__profile__data__attributes__location__address2string
Second line of street address
data__attributes__profile__data__attributes__location__latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__location__timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
data__attributes__profile__data__attributes__location__longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__meta__patch__properties__unsetstring[]
Remove a key or keys (and their values) completely from properties

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create listKLAVIYO_CREATE_LISTAcción

Create a new list. *rate limits*: burst: `10/s` steady: `150/m` daily: `100/d` **scopes:** `lists:write`

Parámetros de entrada

data__typestringenum
Type
list
data__attributes__namestring
A helpful name to label the list

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create or update client profileKLAVIYO_CREATE_OR_UPDATE_CLIENT_PROFILEAcción

Update user profiles without tracking using a public client-side api; use a private server-side api for identifier changes. burst rate is 350 requests/sec and 3500 requests/min with 'profiles:write' access.

Parámetros de entrada

data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
company_idstringObligatorio
Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
data__typestringenum
Type
profile
data__attributes____kxstring
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
data__attributes__emailstring
Individual"s email address
data__attributes__imagestring
URL pointing to the location of a profile image
data__attributes__titlestring
Individual"s job title
data__attributes__last__namestring
Individual"s last name
data__attributes__first__namestring
Individual"s first name
data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__location__ipstring
IP Address
data__attributes__organizationstring
Name of the company or organization within the company for whom the individual works
data__attributes__anonymous__idstring
Anonymous Id
data__attributes__location__zipstring
Zip code
data__attributes__phone__numberstring
Individual"s phone number in E.164 format
data__attributes__location__citystring
City name
data__attributes__location__regionstring
Region within a country, such as state or province
data__attributes__location__countrystring
Country name
data__attributes__location__address1string
First line of street address
data__attributes__location__address2string
Second line of street address
data__attributes__location__latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__location__timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
data__meta__patch__properties__unsetstring[]
Remove a key or keys (and their values) completely from properties
data__attributes__location__longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create or update client push tokenKLAVIYO_CREATE_OR_UPDATE_CLIENT_PUSH_TOKENAcción

This endpoint for mobile sdks (ios & android) creates/updates push tokens using a public api key. push notifications must be enabled. for migrating tokens use the server-side post endpoint. rate limits are 3/s burst, 150/m steady.

Parámetros de entrada

company_idstringObligatorio
Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
data__typestringenum
Type
push-token
data__attributes__tokenstring
A push token from APNS or FCM.
data__attributes__vendorstringenum
The vendor of the push token.
apnsfcm
data__attributes__platformstringenum
The platform on which the push token was created.
androidios
data__attributes__backgroundstringenum
The background state of the push token.
AVAILABLEDENIEDRESTRICTED
data__attributes__profile__data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__attributes__enablement__statusstringenum
This is the enablement status for the individual push token.
AUTHORIZEDDENIEDNOT_DETERMINEDPROVISIONALUNAUTHORIZED
data__attributes__profile__data__typestringenum
Type
profile
data__attributes__device__metadata__app__idstring
The ID of the app that created the push token
data__attributes__device__metadata__os__namestringenum
The name of the operating system on the device.
androidiosipadosmacostvos
data__attributes__device__metadata__app__namestring
The name of the app that created the push token
data__attributes__device__metadata__app__buildstring
The build of the app that created the push token
data__attributes__device__metadata__device__idstring
Relatively stable ID for the device. Will update on app uninstall and reinstall
data__attributes__device__metadata__environmentstringenum
The environment in which the push token was created
debugrelease
data__attributes__device__metadata__os__versionstring
The version of the operating system on the device
data__attributes__device__metadata__app__versionstring
The version of the app that created the push token
data__attributes__device__metadata__klaviyo__sdkstringenum
The name of the SDK used to create the push token.
androidswift
data__attributes__device__metadata__manufacturerstring
The manufacturer of the device
data__attributes__device__metadata__sdk__versionstring
The version of the SDK used to create the push token
data__attributes__device__metadata__device__modelstring
The model of the device
data__attributes__profile__data__attributes____kxstring
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
data__attributes__profile__data__attributes__emailstring
Individual"s email address
data__attributes__profile__data__attributes__imagestring
URL pointing to the location of a profile image
data__attributes__profile__data__attributes__titlestring
Individual"s job title
data__attributes__profile__data__attributes__last__namestring
Individual"s last name
data__attributes__profile__data__attributes__first__namestring
Individual"s first name
data__attributes__profile__data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__profile__data__attributes__location__ipstring
IP Address
data__attributes__profile__data__attributes__organizationstring
Name of the company or organization within the company for whom the individual works
data__attributes__profile__data__attributes__anonymous__idstring
Id that can be used to identify a profile when other identifiers are not available
data__attributes__profile__data__attributes__location__zipstring
Zip code
data__attributes__profile__data__attributes__phone__numberstring
Individual"s phone number in E.164 format
data__attributes__profile__data__attributes__location__citystring
City name
data__attributes__profile__data__attributes__location__regionstring
Region within a country, such as state or province
data__attributes__profile__data__attributes__location__countrystring
Country name
data__attributes__profile__data__attributes__location__address1string
First line of street address
data__attributes__profile__data__attributes__location__address2string
Second line of street address
data__attributes__profile__data__attributes__location__latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__location__timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
data__attributes__profile__data__attributes__location__longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__meta__patch__properties__unsetstring[]
Remove a key or keys (and their values) completely from properties

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create or Update ProfileKLAVIYO_CREATE_OR_UPDATE_PROFILEAcción

Create or update a profile in klaviyo with the given attributes. this action allows you to create a new profile or update an existing one if it already exists (based on email or other identifiers). returns 201 for creation, 200 for update. empty fields are cleared with `null`; omitted fields remain unchanged. rate limits: 75/s burst, 700/m steady. required scope: `profiles:write`. preconditions: - at least one identifier (email, phone number, external id, or anonymous id) must be provided - email must be in valid format if provided - phone number must be in e.164 format if provided

Parámetros de entrada

citystring
City name
emailstringObligatorio
Individual's email address
imagestring
URL pointing to the location of a profile image
titlestring
Individual's job title
regionstring
Region within a country, such as state or province
countrystring
Country name
address1string
First line of street address
address2string
Second line of street address
latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
zip_codestring
Zip code
last_namestring
Individual's last name
longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.
first_namestring
Individual's first name
propertiesobject
Custom properties to associate with the profile
external_idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system
anonymous_idstring
Id that can be used to identify a profile when other identifiers are not available
organizationstring
Name of the company or organization within the company for whom the individual works
phone_numberstring
Individual's phone number in E.164 format

Parámetros de salida

dataobjectObligatorio
The created or updated profile data from Klaviyo
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create or update push tokenKLAVIYO_CREATE_OR_UPDATE_PUSH_TOKENAcción

Migrate or create push tokens with klaviyo's endpoint, utilizing their mobile sdks for ios & android. rate limits: 75/s burst, 700/m steady. requires profiles:write and push-tokens:write scopes.

Parámetros de entrada

data__typestringenum
Type
push-token
data__attributes__tokenstring
A push token from APNS or FCM.
data__attributes__vendorstringenum
The vendor of the push token.
apnsfcm
data__attributes__platformstringenum
The platform on which the push token was created.
androidios
data__attributes__backgroundstringenum
The background state of the push token.
AVAILABLEDENIEDRESTRICTED
data__attributes__profile__data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__attributes__enablement__statusstringenum
This is the enablement status for the individual push token.
AUTHORIZEDDENIEDNOT_DETERMINEDPROVISIONALUNAUTHORIZED
data__attributes__profile__data__typestringenum
Type
profile
data__attributes__device__metadata__app__idstring
The ID of the app that created the push token
data__attributes__device__metadata__os__namestringenum
The name of the operating system on the device.
androidiosipadosmacostvos
data__attributes__device__metadata__app__namestring
The name of the app that created the push token
data__attributes__device__metadata__app__buildstring
The build of the app that created the push token
data__attributes__device__metadata__device__idstring
Relatively stable ID for the device. Will update on app uninstall and reinstall
data__attributes__device__metadata__environmentstringenum
The environment in which the push token was created
debugrelease
data__attributes__device__metadata__os__versionstring
The version of the operating system on the device
data__attributes__device__metadata__app__versionstring
The version of the app that created the push token
data__attributes__device__metadata__klaviyo__sdkstringenum
The name of the SDK used to create the push token.
androidswift
data__attributes__device__metadata__manufacturerstring
The manufacturer of the device
data__attributes__device__metadata__sdk__versionstring
The version of the SDK used to create the push token
data__attributes__device__metadata__device__modelstring
The model of the device
data__attributes__profile__data__attributes____kxstring
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
data__attributes__profile__data__attributes__emailstring
Individual"s email address
data__attributes__profile__data__attributes__imagestring
URL pointing to the location of a profile image
data__attributes__profile__data__attributes__titlestring
Individual"s job title
data__attributes__profile__data__attributes__last__namestring
Individual"s last name
data__attributes__profile__data__attributes__first__namestring
Individual"s first name
data__attributes__profile__data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__profile__data__attributes__location__ipstring
IP Address
data__attributes__profile__data__attributes__organizationstring
Name of the company or organization within the company for whom the individual works
data__attributes__profile__data__attributes__anonymous__idstring
Id that can be used to identify a profile when other identifiers are not available
data__attributes__profile__data__attributes__location__zipstring
Zip code
data__attributes__profile__data__attributes__phone__numberstring
Individual"s phone number in E.164 format
data__attributes__profile__data__attributes__location__citystring
City name
data__attributes__profile__data__attributes__location__regionstring
Region within a country, such as state or province
data__attributes__profile__data__attributes__location__countrystring
Country name
data__attributes__profile__data__attributes__location__address1string
First line of street address
data__attributes__profile__data__attributes__location__address2string
Second line of street address
data__attributes__profile__data__attributes__location__latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__location__timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
data__attributes__profile__data__attributes__location__longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__meta__patch__properties__unsetstring[]
Remove a key or keys (and their values) completely from properties

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create profileKLAVIYO_CREATE_PROFILEAcción

Create a new profile. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `profiles:write`

Parámetros de entrada

data__typestringenum
Type
profile
data__attributes__emailstring
Individual"s email address
data__attributes__imagestring
URL pointing to the location of a profile image
data__attributes__titlestring
Individual"s job title
data__attributes__last__namestring
Individual"s last name
data__attributes__first__namestring
Individual"s first name
data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__location__ipstring
IP Address
data__attributes__organizationstring
Name of the company or organization within the company for whom the individual works
data__attributes__location__zipstring
Zip code
data__attributes__phone__numberstring
Individual"s phone number in E.164 format
data__attributes__location__citystring
City name
data__attributes__location__regionstring
Region within a country, such as state or province
data__attributes__location__countrystring
Country name
data__attributes__location__address1string
First line of street address
data__attributes__location__address2string
Second line of street address
data__attributes__location__latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__location__timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
data__attributes__location__longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create segmentKLAVIYO_CREATE_SEGMENTAcción

Create a segment. *rate limits*: burst: `1/s` steady: `15/m` daily: `100/d` **scopes:** `segments:write`

Parámetros de entrada

data__typestringenum
Type
segment
data__attributes__namestring
Name
data__attributes__is__starredboolean
Is Starred
data__attributes__definition__condition__groupsobject[]
Condition Groups

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create tagKLAVIYO_CREATE_TAGAcción

Summary: instructions on creating a tag within an account's designated tag group with a maximum of 500 tags, with optional tag group specification. rate limits are 3/s burst and 60/min steady. tag: #tagcreationlimitandrate

Parámetros de entrada

data__typestringenum
Type
tag
data__attributes__namestring
The Tag name
data__relationships__tag__group__data__idstring
The ID of the Tag Group to associate the Tag with. If this field is not specified, the Tag will be associated with the company"s Default Tag Group.
data__relationships__tag__group__data__typestringenum
Type
tag-group

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create tag groupKLAVIYO_CREATE_TAG_GROUPAcción

Create tag groups up to 50 per account, defaulting to non-exclusive unless specified. related resources can have multiple non-exclusive tags but only one if exclusive. rate limits: 3/s burst, 60/m steady. scopes needed: tags:read, tags:write.

Parámetros de entrada

data__typestringenum
Type
tag-group
data__attributes__namestring
The Tag Group name
data__attributes__exclusiveboolean
Exclusive

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create tag relationships campaignsKLAVIYO_CREATE_TAG_RELATIONSHIPS_CAMPAIGNSAcción

Summary: link a tag to campaigns, ensuring a limit of 100 tags per campaign. campaign ids should be sent via request body. rate limit: 3/s, 60/m. required scopes: campaigns:write, tags:write. tag: #campaigntagginglimits

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create tag relationships flowsKLAVIYO_CREATE_TAG_RELATIONSHIPS_FLOWSAcción

Assign tags to flows using their ids in the request body, ensuring a flow is not linked to over 100 tags. rate limits are 3/s burst and 60/m steady. required scopes: `flows:write` and `tags:write`. tag: flow-tag association limits

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create tag relationships listsKLAVIYO_CREATE_TAG_RELATIONSHIPS_LISTSAcción

Summary: a tag can be added to one or more lists, with a max of 100 tags per list. use the request body to link tag and list ids. tag: #apiusagelimits scopes: lists:write, tags:write

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create tag relationships segmentsKLAVIYO_CREATE_TAG_RELATIONSHIPS_SEGMENTSAcción

Summary: set tag associations with segments using the request body, limited to one tag per segment and up to 100 tags per segment. rate limits are three requests per second and sixty per minute. tags: segments:write, tags:write

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create templateKLAVIYO_CREATE_TEMPLATEAcción

Summary: custom html templates can be created unless an account reaches 1,000 template limit. use sparse fieldsets to request specific fields. rate limits are 10 per second and 150 per minute. requires 'templates:write' scope.

Parámetros de entrada

data__typestringenum
Type
template
data__attributes__htmlstring
The HTML contents of the template
data__attributes__namestring
The name of the template
data__attributes__textstring
The plaintext version of the template
data__attributes__editor__typestring
Restricted to CODE

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create template cloneKLAVIYO_CREATE_TEMPLATE_CLONEAcción

Clone a template by its id, but cloning fails if account has 1,000+ templates. api limit: 1,000 templates. rate limits are 10 per second and 150 per minute. requires `templates:write` scope.

Parámetros de entrada

data__idstring
The ID of template to be cloned
data__typestringenum
Type
template
data__attributes__namestring
The name of the template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create template renderKLAVIYO_CREATE_TEMPLATE_RENDERAcción

Render an email template with specific context and sparse fieldsets, then get html/plain text. rate limit: 3/s burst, 60/m steady. scope: templates:read.

Parámetros de entrada

data__idstring
The ID of template
data__typestringenum
Type
template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create webhookKLAVIYO_CREATE_WEBHOOKAcción

Create a new webhook *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:write`

Parámetros de entrada

data__typestringenum
Type
webhook
data__attributes__namestring
A name for the webhook.
data__attributes__descriptionstring
A description for the webhook.
data__attributes__secret__keystring
A secret key, that will be used for webhook request signing.
data__attributes__endpoint__urlstring
A url to send webhook calls to. Must be https.
data__relationships__webhook__topics__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete campaignKLAVIYO_DELETE_CAMPAIGNAcción

Delete a campaign with the given campaign id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Parámetros de entrada

idstringObligatorio
The campaign ID to be deleted

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete catalog categoryKLAVIYO_DELETE_CATALOG_CATEGORYAcción

Delete a catalog category using the given category id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete catalog category relationships itemsKLAVIYO_DELETE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSAcción

Delete item relationships for the given category id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete catalog itemKLAVIYO_DELETE_CATALOG_ITEMAcción

Delete a catalog item with the given item id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete catalog item relationships categoriesKLAVIYO_DELETE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESAcción

Delete catalog category relationships for the given item id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete catalog variantKLAVIYO_DELETE_CATALOG_VARIANTAcción

Delete a catalog item variant with the given variant id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete couponKLAVIYO_DELETE_COUPONAcción

Delete the coupon with the given coupon id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `coupons:write`

Parámetros de entrada

idstringObligatorio
The internal id of a Coupon is equivalent to its external id stored within an integration.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete coupon codeKLAVIYO_DELETE_COUPON_CODEAcción

Deletes a coupon code specified by the given identifier synchronously. if a profile has been assigned to the coupon code, an exception will be raised *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `coupon-codes:write`

Parámetros de entrada

idstringObligatorio
The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete flowKLAVIYO_DELETE_FLOWAcción

Delete a flow with the given flow id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:write`

Parámetros de entrada

idstringObligatorio
ID of the Flow to delete. Ex: XVTP5Q

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete listKLAVIYO_DELETE_LISTAcción

Delete a list with the given list id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:write`

Parámetros de entrada

idstringObligatorio
Primary key that uniquely identifies this list. Generated by Klaviyo.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete segmentKLAVIYO_DELETE_SEGMENTAcción

Delete a segment with the given segment id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `segments:write`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete tagKLAVIYO_DELETE_TAGAcción

Delete the tag with the given tag id. any associations between the tag and other resources will also be removed. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read` `tags:write`

Parámetros de entrada

idstringObligatorio
The Tag ID

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete tag groupKLAVIYO_DELETE_TAG_GROUPAcción

Delete a specified tag group and its contents; associated resource links will be removed. the default group is undeletable. rate limits: 3/s burst, 60/m steady. requires tags:read and tags:write permissions.

Parámetros de entrada

idstringObligatorio
The Tag Group ID

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete tag relationships campaignsKLAVIYO_DELETE_TAG_RELATIONSHIPS_CAMPAIGNSAcción

Disconnect a tag from campaigns using the campaign id(s) in the request body. rate limits: 3 requests/second, 60 requests/minute. required scopes: campaigns:write, tags:write.

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete tag relationships flowsKLAVIYO_DELETE_TAG_RELATIONSHIPS_FLOWSAcción

Remove a tag's association with one or more flows. use the request body to pass in the id(s) of the flows(s) whose association with the tag will be removed. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:write` `tags:write`

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete tag relationships listsKLAVIYO_DELETE_TAG_RELATIONSHIPS_LISTSAcción

Remove a tag's association with one or more lists. use the request body to pass in the id(s) of the list(s) whose association with the tag will be removed. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:write` `tags:write`

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete tag relationships segmentsKLAVIYO_DELETE_TAG_RELATIONSHIPS_SEGMENTSAcción

Use the request body to de-associate a tag from specified segment ids. rate limits are 3 requests/sec and 60 requests/min. required scopes are 'segments:write' and 'tags:write'.

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete templateKLAVIYO_DELETE_TEMPLATEAcción

Delete a template with the given template id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `templates:write`

Parámetros de entrada

idstringObligatorio
The ID of template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete webhookKLAVIYO_DELETE_WEBHOOKAcción

Delete a webhook with the given id. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:write`

Parámetros de entrada

idstringObligatorio
The ID of the webhook.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get accountKLAVIYO_GET_ACCOUNTAcción

Retrieve a single account object by its account id. you can only request the account by which the private api key was generated. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `accounts:read`

Parámetros de entrada

idstringObligatorio
The ID of the account
fields__accountstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get accountsKLAVIYO_GET_ACCOUNTSAcción

Use a private api key to fetch an associated account's details like contact info, timezone, and currency, as well as validate the key. rate limit: 1 request/second, 15 requests/minute. scope required: `accounts:read`.

Parámetros de entrada

fields__accountstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get bulk profile import jobKLAVIYO_GET_BULK_PROFILE_IMPORT_JOBAcción

Get a bulk profile import job with the given job id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:read` `profiles:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__liststring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__profile__bulk__import__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get bulk profile import job errorsKLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_ERRORSAcción

Get import errors for the bulk profile import job with the given id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `profiles:read`

Parámetros de entrada

idstringObligatorio
page__sizeinteger
Default: 20. Min: 1. Max: 100.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__import__errorstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get bulk profile import job listsKLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_LISTSAcción

Get list for the bulk profile import job with the given id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:read`

Parámetros de entrada

idstringObligatorio
fields__liststring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get bulk profile import job profilesKLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_PROFILESAcción

Get profiles for the bulk profile import job with the given id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `profiles:read`

Parámetros de entrada

idstringObligatorio
page__sizeinteger
Default: 20. Min: 1. Max: 100.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__profilestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
additional__fields__profilestring[]
Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get bulk profile import job relationships listsKLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_LISTSAcción

Get list relationship for the bulk profile import job with the given id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get bulk profile import job relationships profilesKLAVIYO_GET_BULK_PROFILE_IMPORT_JOB_RELATIONSHIPS_PROFILESAcción

Get profile relationships for the bulk profile import job with the given id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `profiles:read`

Parámetros de entrada

idstringObligatorio
page__sizeinteger
Default: 20. Min: 1. Max: 100.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get bulk profile import jobsKLAVIYO_GET_BULK_PROFILE_IMPORT_JOBSAcción

Get all bulk profile import jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:read` `profiles:read`

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created_at-created_at
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `any`, `equals`
page__sizeinteger
Default: 20. Min: 1. Max: 100.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__profile__bulk__import__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CampaignKLAVIYO_GET_CAMPAIGNAcción

Retrieve a specific campaign by its id from klaviyo. this action fetches detailed information about a single campaign including its name, status, audience settings, send strategy, and optionally related messages and tags. rate limits: 10/s burst, 150/m steady. required scope: `campaigns:read`. preconditions: - valid api key with campaigns:read scope - campaign id must exist and be accessible

Parámetros de entrada

campaign_idstringObligatorio
The campaign ID to retrieve
include_tagsboolean
Whether to include tags in the response
include_messagesboolean
Whether to include campaign messages in the response

Parámetros de salida

dataobjectObligatorio
Campaign data from Klaviyo
errorstring
Error if any occurred during the execution of the action
includedobject[]
Included related objects (messages, tags) if requested
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign campaign messagesKLAVIYO_GET_CAMPAIGN_CAMPAIGN_MESSAGESAcción

Return all messages that belong to the given campaign. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Parámetros de entrada

idstringObligatorio
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__campaignstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__templatestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__campaign__messagestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign messageKLAVIYO_GET_CAMPAIGN_MESSAGEAcción

Returns a specific message based on a required id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Parámetros de entrada

idstringObligatorio
The message ID to be retrieved
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__campaignstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__templatestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__campaign__messagestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign message campaignKLAVIYO_GET_CAMPAIGN_MESSAGE_CAMPAIGNAcción

Return the related campaign *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Parámetros de entrada

idstringObligatorio
fields__campaignstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign message relationships campaignKLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_CAMPAIGNAcción

Returns the id of the related campaign *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign message relationships templateKLAVIYO_GET_CAMPAIGN_MESSAGE_RELATIONSHIPS_TEMPLATEAcción

Returns the id of the related template *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read` `templates:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign message templateKLAVIYO_GET_CAMPAIGN_MESSAGE_TEMPLATEAcción

Return the related template *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read` `templates:read`

Parámetros de entrada

idstringObligatorio
fields__templatestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign recipient estimationKLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATIONAcción

Get estimated recipients for a given campaign id using `create campaign recipient estimation job`. rate limits are 10/s burst and 150/m steady. required scope: `campaigns:read`.

Parámetros de entrada

idstringObligatorio
The ID of the campaign for which to get the estimated number of recipients
fields__campaign__recipient__estimationstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign recipient estimation jobKLAVIYO_GET_CAMPAIGN_RECIPIENT_ESTIMATION_JOBAcción

Retrieve the status of a recipient estimation job triggered with the `create campaign recipient estimation job` endpoint. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Parámetros de entrada

idstringObligatorio
The ID of the campaign to get recipient estimation status
fields__campaign__recipient__estimation__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign relationships campaign messagesKLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_CAMPAIGN_MESSAGESAcción

Returns the ids of all messages associated with the given campaign. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign relationships tagsKLAVIYO_GET_CAMPAIGN_RELATIONSHIPS_TAGSAcción

Returns the ids of all tags associated with the given campaign. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `campaigns:read` `tags:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CampaignsKLAVIYO_GET_CAMPAIGNSAcción

Retrieve campaigns from your klaviyo account. this action allows you to fetch campaigns with optional filtering and sorting. klaviyo requires specifying a channel (email or sms) to list campaigns. you can add additional filters for status, name, creation date, and other attributes. results are paginated with a default of 10 campaigns per page. rate limits: 10/s burst, 150/m steady. required scope: `campaigns:read`. preconditions: - valid api key with campaigns:read scope - channel must be specified (email or sms) - additional filter syntax must be valid if provided

Parámetros de entrada

sortstringenum
Sort campaigns by field (add '-' prefix for descending order)
created-createdid-idname-nameupdated-updated
filterstring
Additional filter for campaigns. Will be combined with the required channel filter. Example: 'equals(status,"draft")'
channelstringenum
Campaign channel to filter by (email or sms). Required by Klaviyo API.
emailsms
page_cursorstring
Cursor for pagination to get the next page of results
include_archivedboolean
Whether to include archived campaigns in the results

Parámetros de salida

dataobject[]Obligatorio
List of campaign objects from Klaviyo
errorstring
Error if any occurred during the execution of the action
linksobject
Pagination links for navigating through results
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign send jobKLAVIYO_GET_CAMPAIGN_SEND_JOBAcción

Get a campaign send job *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:read`

Parámetros de entrada

idstringObligatorio
The ID of the campaign to send
fields__campaign__send__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get campaign tagsKLAVIYO_GET_CAMPAIGN_TAGSAcción

Return all tags that belong to the given campaign. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `campaigns:read` `tags:read`

Parámetros de entrada

idstringObligatorio
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog categoriesKLAVIYO_GET_CATALOG_CATEGORIESAcción

Retrieve up to 100 account catalog categories, sortable by creation date. only `$custom` integration and `$default` catalog types supported. rate limits are 350/s and 3500/m. requires `catalogs:read` scope.

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-created
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `ids`: `any` `item.id`: `equals` `name`: `contains`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__categorystring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog categoryKLAVIYO_GET_CATALOG_CATEGORYAcción

Get a catalog category with the given category id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

idstringObligatorio
The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
fields__catalog__categorystring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog category itemsKLAVIYO_GET_CATALOG_CATEGORY_ITEMSAcción

Retrieve up to 100 sorted items per request from a category using the category id. sort by 'created' field. rate limits are 350/s burst and 3500/m steady. requires 'catalogs:read' scope.

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-created
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `ids`: `any` `category.id`: `equals` `title`: `contains` `published`: `equals`
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__itemstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__catalog__variantstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog category relationships itemsKLAVIYO_GET_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSAcción

Get all items in the given category id. returns a maximum of 100 items per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

idstringObligatorio
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog itemKLAVIYO_GET_CATALOG_ITEMAcción

Get a specific catalog item with the given item id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

idstringObligatorio
The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__catalog__itemstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__catalog__variantstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog item categoriesKLAVIYO_GET_CATALOG_ITEM_CATEGORIESAcción

Retrieve the catalog categories for an item by id, sorted by 'created' date, with a 100-category maximum per request. rate limits: 350/s burst, 3500/m steady. requires 'catalogs:read' scope.

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-created
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `ids`: `any` `item.id`: `equals` `name`: `contains`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__categorystring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog item relationships categoriesKLAVIYO_GET_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESAcción

Get all catalog categories that a particular item is in. returns a maximum of 100 categories per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

idstringObligatorio
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog itemsKLAVIYO_GET_CATALOG_ITEMSAcción

Retrieve up to 100 sorted catalog items per account, with `$custom` integration and `$default` type. rate limits: 350/s burst, 3500/m steady. scope required: `catalogs:read`.

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-created
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `ids`: `any` `category.id`: `equals` `title`: `contains` `published`: `equals`
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__itemstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__catalog__variantstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog item variantsKLAVIYO_GET_CATALOG_ITEM_VARIANTSAcción

Retrieve up to 100 variants per request for a specific item id, sortable by creation date. rate limits are 350/s burst and 3500/m steady. requires 'catalogs:read' scope.

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-created
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `ids`: `any` `item.id`: `equals` `sku`: `equals` `title`: `contains` `published`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__variantstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog variantKLAVIYO_GET_CATALOG_VARIANTAcción

Get a catalog item variant with the given variant id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

idstringObligatorio
The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
fields__catalog__variantstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get catalog variantsKLAVIYO_GET_CATALOG_VARIANTSAcción

Retrieve up to 100 account variants per request, sortable by creation date. supports only `$custom` integration and `$default` catalog types. rate limits are 350/s burst and 3500/m steady. requires `catalogs:read` scope.

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-created
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `ids`: `any` `item.id`: `equals` `sku`: `equals` `title`: `contains` `published`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__variantstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get couponKLAVIYO_GET_COUPONAcción

Get a specific coupon with the given coupon id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupons:read`

Parámetros de entrada

idstringObligatorio
The internal id of a Coupon is equivalent to its external id stored within an integration.
fields__couponstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get coupon codeKLAVIYO_GET_COUPON_CODEAcción

Returns a coupon code specified by the given identifier. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `coupon-codes:read`

Parámetros de entrada

idstringObligatorio
The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__couponstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__coupon__codestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get coupon code bulk create jobKLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBAcción

Get a coupon code bulk create job with the given job id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupon-codes:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__coupon__codestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__coupon__code__bulk__create__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get coupon code bulk create jobsKLAVIYO_GET_COUPON_CODE_BULK_CREATE_JOBSAcción

Get all coupon code bulk create jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupon-codes:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__coupon__code__bulk__create__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get coupon code relationships couponKLAVIYO_GET_COUPON_CODE_RELATIONSHIPS_COUPONAcción

Gets a list of coupon code relationships associated with the given coupon id *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupon-codes:read`

Parámetros de entrada

idstringObligatorio
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get coupon codesKLAVIYO_GET_COUPON_CODESAcción

Obtains coupon codes using necessary coupon or profile filters. rate limits: 350/s, 3500/m. requires 'coupon-codes:read' scope.

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `status`: `equals` `coupon.id`: `any`, `equals` `profile.id`: `any`, `equals`
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__couponstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__coupon__codestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get coupon codes for couponKLAVIYO_GET_COUPON_CODES_FOR_COUPONAcción

Gets a list of coupon codes associated with the given coupon id *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupon-codes:read`

Parámetros de entrada

idstringObligatorio
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `expires_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `status`: `equals` `coupon.id`: `any`, `equals` `profile.id`: `any`, `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__coupon__codestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get coupon for coupon codeKLAVIYO_GET_COUPON_FOR_COUPON_CODEAcción

Get the coupon associated with a given coupon code id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupons:read`

Parámetros de entrada

idstringObligatorio
fields__couponstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get coupon relationships coupon codesKLAVIYO_GET_COUPON_RELATIONSHIPS_COUPON_CODESAcción

Gets the coupon relationship associated with the given coupon code id *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupons:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get couponsKLAVIYO_GET_COUPONSAcción

Get all coupons in an account. to learn more, see our [coupons api guide](https://developers.klaviyo.com/en/docs/use klaviyos coupons api). *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupons:read`

Parámetros de entrada

page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__couponstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get create categories jobKLAVIYO_GET_CREATE_CATEGORIES_JOBAcción

Get a catalog category bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `categories`. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__catalog__categorystring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__catalog__category__bulk__create__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get create categories jobsKLAVIYO_GET_CREATE_CATEGORIES_JOBSAcción

Get all catalog category bulk create jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__category__bulk__create__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get create items jobKLAVIYO_GET_CREATE_ITEMS_JOBAcción

Get a catalog item bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `items`. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__catalog__itemstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__catalog__item__bulk__create__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get create items jobsKLAVIYO_GET_CREATE_ITEMS_JOBSAcción

Get all catalog item bulk create jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__item__bulk__create__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get create variants jobKLAVIYO_GET_CREATE_VARIANTS_JOBAcción

Get a catalog variant bulk create job with the given job id. an `include` parameter can be provided to get the following related resource data: `variants`. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__catalog__variantstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__catalog__variant__bulk__create__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get create variants jobsKLAVIYO_GET_CREATE_VARIANTS_JOBSAcción

Get all catalog variant bulk create jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__variant__bulk__create__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get delete categories jobKLAVIYO_GET_DELETE_CATEGORIES_JOBAcción

Get a catalog category bulk delete job with the given job id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
fields__catalog__category__bulk__delete__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get delete categories jobsKLAVIYO_GET_DELETE_CATEGORIES_JOBSAcción

Get all catalog category bulk delete jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__category__bulk__delete__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get delete items jobKLAVIYO_GET_DELETE_ITEMS_JOBAcción

Get a catalog item bulk delete job with the given job id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
fields__catalog__item__bulk__delete__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get delete items jobsKLAVIYO_GET_DELETE_ITEMS_JOBSAcción

Get all catalog item bulk delete jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__item__bulk__delete__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get delete variants jobKLAVIYO_GET_DELETE_VARIANTS_JOBAcción

Get a catalog variant bulk delete job with the given job id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
fields__catalog__variant__bulk__delete__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get delete variants jobsKLAVIYO_GET_DELETE_VARIANTS_JOBSAcción

Get all catalog variant bulk delete jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__variant__bulk__delete__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get eventKLAVIYO_GET_EVENTAcción

Get an event with the given event id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `events:read`

Parámetros de entrada

idstringObligatorio
ID of the event
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__eventstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__metricstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__profilestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get event metricKLAVIYO_GET_EVENT_METRICAcción

Get the metric for an event with the given event id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `events:read` `metrics:read`

Parámetros de entrada

idstringObligatorio
fields__metricstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get event profileKLAVIYO_GET_EVENT_PROFILEAcción

Get the profile associated with an event with the given event id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `events:read` `profiles:read`

Parámetros de entrada

idstringObligatorio
fields__profilestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
additional__fields__profilestring[]
Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get event relationships metricKLAVIYO_GET_EVENT_RELATIONSHIPS_METRICAcción

Get a list of related metrics for an event *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `events:read` `metrics:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get event relationships profileKLAVIYO_GET_EVENT_RELATIONSHIPS_PROFILEAcción

Get profile [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for an event with the given event id. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `events:read` `profiles:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get eventsKLAVIYO_GET_EVENTSAcción

Get all events in an account requests can be sorted by the following fields: `datetime`, `timestamp` returns a maximum of 200 events per page. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `events:read`

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
datetime-datetimetimestamp-timestamp
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `metric_id`: `equals` `profile_id`: `equals` `profile`: `has` `datetime`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `timestamp`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__eventstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__metricstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__profilestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flowKLAVIYO_GET_FLOWAcción

Get a flow with the given flow id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Parámetros de entrada

idstringObligatorio
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__flowstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__flow__actionstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow actionKLAVIYO_GET_FLOW_ACTIONAcción

Get a flow action from a flow with the given flow action id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Parámetros de entrada

idstringObligatorio
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__flowstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__flow__actionstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__flow__messagestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow action for messageKLAVIYO_GET_FLOW_ACTION_FOR_MESSAGEAcción

Get the flow action for a flow message with the given message id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Parámetros de entrada

idstringObligatorio
fields__flow__actionstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow action messagesKLAVIYO_GET_FLOW_ACTION_MESSAGESAcción

Retrieve up to 50 flow messages per request by action id, sortable by various fields, with ascending/descending options, and paginated using `page[size]` and `page[number]`. rate limits: 3/s burst, 60/m steady. scope required: `flows:read`.

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-createdid-idname-nameupdated-updated
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `id`: `any` `name`: `contains`, `ends-with`, `equals`, `starts-with` `created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
page__sizeinteger
Default: 50. Min: 1. Max: 100.
fields__flow__messagestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow action relationships flowKLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_FLOWAcción

Get the flow associated with the given action id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow action relationships messagesKLAVIYO_GET_FLOW_ACTION_RELATIONSHIPS_MESSAGESAcción

Retrieves up to 50 flow message relationships per request for a specified flow action id, with cursor pagination. rate limits: 3/s burst, 60/min steady. requires `flows:read` scope.

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-createdid-idname-nameupdated-updated
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `name`: `contains`, `ends-with`, `equals`, `starts-with` `created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
page__sizeinteger
Default: 50. Min: 1. Max: 50.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow flow actionsKLAVIYO_GET_FLOW_FLOW_ACTIONSAcción

Get all flow actions associated with the given flow id. returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
action_type-action_typecreated-createdid-idstatus-statusupdated-updated
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `id`: `any` `action_type`: `any`, `equals` `status`: `equals` `created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
page__sizeinteger
Default: 50. Min: 1. Max: 50.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__flow__actionstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow for flow actionKLAVIYO_GET_FLOW_FOR_FLOW_ACTIONAcción

Get the flow associated with the given action id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Parámetros de entrada

idstringObligatorio
fields__flowstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow messageKLAVIYO_GET_FLOW_MESSAGEAcción

Get the flow message of a flow with the given message id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Parámetros de entrada

idstringObligatorio
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__templatestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__flow__actionstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__flow__messagestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow message relationships actionKLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_ACTIONAcción

Get the [relationship](https://developers.klaviyo.com/en/reference/api overview#relationships) for a flow message's flow action, given the flow id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow message relationships templateKLAVIYO_GET_FLOW_MESSAGE_RELATIONSHIPS_TEMPLATEAcción

Returns the id of the related template *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `templates:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow message templateKLAVIYO_GET_FLOW_MESSAGE_TEMPLATEAcción

Return the related template *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `templates:read`

Parámetros de entrada

idstringObligatorio
fields__templatestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow relationships flow actionsKLAVIYO_GET_FLOW_RELATIONSHIPS_FLOW_ACTIONSAcción

Retrieve all flow action relationships for a specific flow id, sortable by `id`, `status`, `created`, `updated`. refine with filters, max 50 per page, paginated by `page[size]` and `page[number]`. rate limits: burst 3/s, steady 60/m. scope: `flows:read`.

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-createdid-idstatus-statusupdated-updated
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `action_type`: `equals` `status`: `equals` `created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
page__sizeinteger
Default: 50. Min: 1. Max: 100.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow relationships tagsKLAVIYO_GET_FLOW_RELATIONSHIPS_TAGSAcción

Return the tag ids of all tags associated with the given flow. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read` `tags:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flowsKLAVIYO_GET_FLOWSAcción

Get all flows in an account. returns a maximum of 50 flows per request, which can be paginated with cursor-based pagination. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read`

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-createdid-idname-namestatus-statustrigger_type-trigger_typeupdated-updated
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `id`: `any` `name`: `contains`, `ends-with`, `equals`, `starts-with` `status`: `equals` `archived`: `equals` `created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `trigger_type`: `equals`
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
page__sizeinteger
Default: 50. Min: 1. Max: 50.
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__flowstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__flow__actionstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get flow tagsKLAVIYO_GET_FLOW_TAGSAcción

Return all tags associated with the given flow id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read` `tags:read`

Parámetros de entrada

idstringObligatorio
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get formKLAVIYO_GET_FORMAcción

Get the form with the given id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Parámetros de entrada

idstringObligatorio
The ID of the form
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__formstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__form__versionstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get form for form versionKLAVIYO_GET_FORM_FOR_FORM_VERSIONAcción

Get the form associated with the given form version. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Parámetros de entrada

idstringObligatorio
fields__formstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get form id for form versionKLAVIYO_GET_FORM_ID_FOR_FORM_VERSIONAcción

Get the id of the form associated with the given form version. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get formsKLAVIYO_GET_FORMSAcción

Get all forms in an account. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created_at-created_atupdated_at-updated_at
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `id`: `any`, `equals` `name`: `any`, `contains`, `equals` `ab_test`: `equals` `updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `status`: `equals`
page__sizeinteger
Default: 20. Min: 1. Max: 100.
fields__formstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get form versionKLAVIYO_GET_FORM_VERSIONAcción

Get the form version with the given id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Parámetros de entrada

idstringObligatorio
The ID of the form version
fields__form__versionstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get imageKLAVIYO_GET_IMAGEAcción

Get the image with the given image id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `images:read`

Parámetros de entrada

idstringObligatorio
The ID of the image
fields__imagestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get imagesKLAVIYO_GET_IMAGESAcción

Get all images in an account. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `images:read`

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
format-formatid-idname-namesize-sizeupdated_at-updated_at
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `id`: `any`, `equals` `updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `format`: `any`, `equals` `name`: `any`, `contains`, `ends-with`, `equals`, `starts-with` `size`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `hidden`: `any`, `equals`
page__sizeinteger
Default: 20. Min: 1. Max: 100.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__imagestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get listKLAVIYO_GET_LISTAcción

Api allows 75 req/sec and 700 req/min, but with 'profile count' param, it's 1 req/sec and 15 req/min. 'lists:read' scope needed. see developer guide for details.

Parámetros de entrada

idstringObligatorio
Primary key that uniquely identifies this list. Generated by Klaviyo.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__liststring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
additional__fields__liststring[]
Request additional fields not included by default in the response. Supported values: "profile_count"

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get list profilesKLAVIYO_GET_LIST_PROFILESAcción

Retrieve profiles in a list by id, filterable by email/phone/push token/join date, sortable by join date. regular rate limit: 75/s, 700/m; with predictive analytics: 10/s, 150/m. details at klaviyo guide. scopes required: lists:read, profiles:read.

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
joined_group_at-joined_group_at
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `email`: `any`, `equals` `phone_number`: `any`, `equals` `push_token`: `any`, `equals` `_kx`: `equals` `joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
page__sizeinteger
Default: 20. Min: 1. Max: 100.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__profilestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
additional__fields__profilestring[]
Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get list relationships profilesKLAVIYO_GET_LIST_RELATIONSHIPS_PROFILESAcción

Get profile membership [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for a list with the given list id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `lists:read` `profiles:read`

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
joined_group_at-joined_group_at
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `email`: `any`, `equals` `phone_number`: `any`, `equals` `push_token`: `any`, `equals` `_kx`: `equals` `joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
page__sizeinteger
Default: 20. Min: 1. Max: 1000.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get list relationships tagsKLAVIYO_GET_LIST_RELATIONSHIPS_TAGSAcción

Returns the tag ids of all tags associated with the given list. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:read` `tags:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ListsKLAVIYO_GET_LISTSAcción

Retrieve marketing lists from your klaviyo account. this action allows you to fetch lists with optional filtering and sorting. you can filter by name, creation date, and other attributes. results are paginated with a default of 10 lists per page. rate limits: 75/s burst, 700/m steady. required scope: `lists:read`. preconditions: - valid api key with lists:read scope - filter syntax must be valid if provided

Parámetros de entrada

sortstringenum
Sort lists by field (add '-' prefix for descending order)
created-createdid-idname-nameupdated-updated
filterstring
Filter lists by name, creation date, etc. Example: 'equals(name,"Newsletter")'
page_cursorstring
Cursor for pagination to get the next page of results
include_tagsboolean
Whether to include tags associated with the lists

Parámetros de salida

dataobject[]Obligatorio
List of list objects from Klaviyo
errorstring
Error if any occurred during the execution of the action
linksobject
Pagination links for navigating through results
includedobject[]
Included tag objects if requested
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get list tagsKLAVIYO_GET_LIST_TAGSAcción

Return all tags associated with the given list id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:read` `tags:read`

Parámetros de entrada

idstringObligatorio
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get metricKLAVIYO_GET_METRICAcción

Get a metric with the given metric id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `metrics:read`

Parámetros de entrada

idstringObligatorio
Metric ID
fields__metricstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get metricsKLAVIYO_GET_METRICSAcción

Get all metrics in an account. requests can be filtered by the following fields: integration `name`, integration `category` returns a maximum of 200 results per page. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `metrics:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `integration.name`: `equals` `integration.category`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__metricstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get profileKLAVIYO_GET_PROFILEAcción

Get the profile with the given profile id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `profiles:read`

Parámetros de entrada

idstringObligatorio
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__liststring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__profilestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__segmentstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
additional__fields__profilestring[]
Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get profile listsKLAVIYO_GET_PROFILE_LISTSAcción

Get list memberships for a profile with the given profile id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:read` `profiles:read`

Parámetros de entrada

idstringObligatorio
fields__liststring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get profile relationships listsKLAVIYO_GET_PROFILE_RELATIONSHIPS_LISTSAcción

Get list memberships for a profile with the given profile id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:read` `profiles:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get profile relationships segmentsKLAVIYO_GET_PROFILE_RELATIONSHIPS_SEGMENTSAcción

Get segment membership relationships for a profile with the given profile id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `profiles:read` `segments:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ProfilesKLAVIYO_GET_PROFILESAcción

Retrieve profiles from your klaviyo account. this action allows you to fetch profiles with optional filtering and sorting. you can filter by email, external id, creation date, and other attributes. results are paginated with a configurable page size. rate limits: 75/s burst, 700/m steady (lower with predictive analytics). required scope: `profiles:read`. preconditions: - valid api key with profiles:read scope - filter syntax must be valid if provided - page size must be between 1 and 100

Parámetros de entrada

sortstringenum
Sort profiles by field (add '-' prefix for descending order)
created-createdemail-emailid-idupdated-updated
filterstring
Filter profiles by email, external_id, created date, etc. Example: 'equals(email,"user@example.com")'
page_sizeinteger
Number of profiles to return per page (1-100)
page_cursorstring
Cursor for pagination to get the next page of results
include_subscriptionsboolean
Whether to include subscription information in the response
include_predictive_analyticsboolean
Whether to include predictive analytics data (note: this may reduce rate limits)

Parámetros de salida

dataobject[]Obligatorio
List of profile objects from Klaviyo
errorstring
Error if any occurred during the execution of the action
linksobject
Pagination links for navigating through results
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get profile segmentsKLAVIYO_GET_PROFILE_SEGMENTSAcción

Get segment memberships for a profile with the given profile id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `profiles:read` `segments:read`

Parámetros de entrada

idstringObligatorio
fields__segmentstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get segmentKLAVIYO_GET_SEGMENTAcción

Fetch a segment by id with default rates of 75/s and 700/m, or with `additional-fields` at 1/s and 15/m. for details, visit the provided guide. required scope: `segments:read`.

Parámetros de entrada

idstringObligatorio
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__segmentstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
additional__fields__segmentstring[]
Request additional fields not included by default in the response. Supported values: "profile_count"

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get segment profilesKLAVIYO_GET_SEGMENT_PROFILESAcción

Retrieve profiles in a segment by id, filtering by email, phone, token, or join date, and sorting by join date. rate limit: 75/s burst, 700/m steady. requires profiles:read and segments:read scopes.

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
joined_group_at-joined_group_at
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `email`: `any`, `equals` `phone_number`: `any`, `equals` `push_token`: `any`, `equals` `_kx`: `equals` `joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
page__sizeinteger
Default: 20. Min: 1. Max: 100.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__profilestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
additional__fields__profilestring[]
Request additional fields not included by default in the response. Supported values: "subscriptions", "predictive_analytics"

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get segment relationships profilesKLAVIYO_GET_SEGMENT_RELATIONSHIPS_PROFILESAcción

Get all profile membership [relationships](https://developers.klaviyo.com/en/reference/api overview#relationships) for the given segment id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `profiles:read` `segments:read`

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
joined_group_at-joined_group_at
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `email`: `any`, `equals` `phone_number`: `any`, `equals` `push_token`: `any`, `equals` `_kx`: `equals` `joined_group_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
page__sizeinteger
Default: 20. Min: 1. Max: 1000.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get segment relationships tagsKLAVIYO_GET_SEGMENT_RELATIONSHIPS_TAGSAcción

If `related resource` is `tags`, returns the tag ids of all tags associated with the given segment id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `segments:read` `tags:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get segmentsKLAVIYO_GET_SEGMENTSAcción

Fetch segments from an account with filters like `name`, `created`, and `updated`. max 10 results/page. rate limits are 75/s burst, 700/m steady. requires `segments:read` scope.

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-createdid-idname-nameupdated-updated
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `name`: `any`, `equals` `id`: `any`, `equals` `created`: `greater-than` `updated`: `greater-than` `is_active`: `any`, `equals` `is_starred`: `equals`
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__segmentstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get segment tagsKLAVIYO_GET_SEGMENT_TAGSAcción

Return all tags associated with the given segment id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `segments:read` `tags:read`

Parámetros de entrada

idstringObligatorio
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tagKLAVIYO_GET_TAGAcción

Retrieve the tag with the given tag id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

Parámetros de entrada

idstringObligatorio
The Tag ID
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__tag__groupstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tag groupKLAVIYO_GET_TAG_GROUPAcción

Retrieve the tag group with the given tag group id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

Parámetros de entrada

idstringObligatorio
The Tag Group ID
fields__tag__groupstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tag group relationships tagsKLAVIYO_GET_TAG_GROUP_RELATIONSHIPS_TAGSAcción

Returns the tag ids of all tags inside the given tag group. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tag groupsKLAVIYO_GET_TAG_GROUPSAcción

Retrieve up to 25 tag groups per account, sortable/filterable by specific attributes. default group included. supports cursor pagination and adheres to rate limits of 3 requests per second and 60 per minute. requires `tags:read` scope.

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
id-idname-name
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `name`: `contains`, `ends-with`, `equals`, `starts-with` `exclusive`: `equals` `default`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__tag__groupstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tag group tagsKLAVIYO_GET_TAG_GROUP_TAGSAcción

Return the tags for a given tag group id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

Parámetros de entrada

idstringObligatorio
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tag relationships campaignsKLAVIYO_GET_TAG_RELATIONSHIPS_CAMPAIGNSAcción

Returns the ids of all campaigns associated with the given tag. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `campaigns:read` `tags:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tag relationships flowsKLAVIYO_GET_TAG_RELATIONSHIPS_FLOWSAcción

Returns the ids of all flows associated with the given tag. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:read` `tags:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tag relationships listsKLAVIYO_GET_TAG_RELATIONSHIPS_LISTSAcción

Returns the ids of all lists associated with the given tag. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `lists:read` `tags:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tag relationships segmentsKLAVIYO_GET_TAG_RELATIONSHIPS_SEGMENTSAcción

Returns the ids of all segments associated with the given tag. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `segments:read` `tags:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tag relationships tag groupKLAVIYO_GET_TAG_RELATIONSHIPS_TAG_GROUPAcción

Returns the id of the tag group related to the given tag. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tagsKLAVIYO_GET_TAGSAcción

Retrieve up to 50 account tags at once, filterable/sortable by name or id, with cursor pagination. rate limits: 3/s burst, 60/m steady. requires `tags:read` scope.

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
id-idname-name
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `name`: `contains`, `ends-with`, `equals`, `starts-with`
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__tagstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__tag__groupstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get tag tag groupKLAVIYO_GET_TAG_TAG_GROUPAcción

Returns the tag group resource for a given tag id. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read`

Parámetros de entrada

idstringObligatorio
fields__tag__groupstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get templateKLAVIYO_GET_TEMPLATEAcción

Get a template with the given template id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `templates:read`

Parámetros de entrada

idstringObligatorio
The ID of template
fields__templatestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get templatesKLAVIYO_GET_TEMPLATESAcción

Retrieve account templates with sorting options (`id`, `name`, `created`, `updated`). limit of 10 results per page, rate limits at 10/s burst and 150/m steady. requires `templates:read` scope.

Parámetros de entrada

sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created-createdid-idname-nameupdated-updated
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `id`: `any`, `equals` `name`: `any`, `equals` `created`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `updated`: `equals`, `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__templatestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get update categories jobKLAVIYO_GET_UPDATE_CATEGORIES_JOBAcción

Get a catalog category bulk update job with the given job id. an `include` parameter can be provided to get the following related resource data: `categories`. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__catalog__categorystring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__catalog__category__bulk__update__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get update categories jobsKLAVIYO_GET_UPDATE_CATEGORIES_JOBSAcción

Get all catalog category bulk update jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__category__bulk__update__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get update items jobKLAVIYO_GET_UPDATE_ITEMS_JOBAcción

Get a catalog item bulk update job with the given job id. an `include` parameter can be provided to get the following related resource data: `items`. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__catalog__itemstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__catalog__item__bulk__update__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get update items jobsKLAVIYO_GET_UPDATE_ITEMS_JOBSAcción

Get all catalog item bulk update jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__item__bulk__update__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get update variants jobKLAVIYO_GET_UPDATE_VARIANTS_JOBAcción

Get a catalog variate bulk update job with the given job id. an `include` parameter can be provided to get the following related resource data: `variants`. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

job_idstringObligatorio
ID of the job to retrieve.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__catalog__variantstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets
fields__catalog__variant__bulk__update__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get update variants jobsKLAVIYO_GET_UPDATE_VARIANTS_JOBSAcción

Get all catalog variant bulk update jobs. returns a maximum of 100 jobs per request. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `catalogs:read`

Parámetros de entrada

filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `status`: `equals`
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__catalog__variant__bulk__update__jobstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get version ids for formKLAVIYO_GET_VERSION_IDS_FOR_FORMAcción

Get the ids of the form versions for the given form. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Parámetros de entrada

idstringObligatorio

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get versions for formKLAVIYO_GET_VERSIONS_FOR_FORMAcción

Get the form versions for the given form. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `forms:read`

Parámetros de entrada

idstringObligatorio
sortstringenum
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sorting
created_at-created_atupdated_at-updated_at
filterstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#filtering Allowed field(s)/operator(s): `form_type`: `any`, `equals` `status`: `equals` `updated_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than` `created_at`: `greater-or-equal`, `greater-than`, `less-or-equal`, `less-than`
page__sizeinteger
Default: 20. Min: 1. Max: 100.
page__cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
fields__form__versionstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get webhookKLAVIYO_GET_WEBHOOKAcción

Get the webhook with the given id. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:read`

Parámetros de entrada

idstringObligatorio
The ID of the webhook.
includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__webhookstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get webhooksKLAVIYO_GET_WEBHOOKSAcción

Get all webhooks in an account. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:read`

Parámetros de entrada

includestring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#relationships
fields__webhookstring[]
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#sparse-fieldsets

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get webhook topicKLAVIYO_GET_WEBHOOK_TOPICAcción

Get the webhook topic with the given id. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:read`

Parámetros de entrada

idstringObligatorio
The ID of the webhook topic.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get webhook topicsKLAVIYO_GET_WEBHOOK_TOPICSAcción

Get all webhook topics in a klaviyo account. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:read`

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Merge profilesKLAVIYO_MERGE_PROFILESAcción

Queue a task to merge one source profile into a destination profile using their ids. deletes the source afterwards. visit help center for details. rate limits: 10/s burst, 150/m steady. needs `profiles:write` scope.

Parámetros de entrada

data__idstring
The ID of the destination profile to merge into
data__typestringenum
Type
profile-merge
data__relationships__profiles__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Query campaign valuesKLAVIYO_QUERY_CAMPAIGN_VALUESAcción

Returns the requested campaign analytics values data *rate limits*: burst: `1/s` steady: `2/m` daily: `225/d` **scopes:** `campaigns:read`

Parámetros de entrada

data__typestringenum
Type
campaign-values-report
page_cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
data__attributes__filterstring
API filter string used to filter the query. Allowed filters are send_channel, campaign_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. When filtering on send_channel, allowed values are email, push-notification, sms.
data__attributes__timeframeobject
The timeframe to query for data within. The max length a timeframe can be is 1 year
data__attributes__statisticsstring[]
List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]
data__attributes__conversion__metric__idstring
ID of the metric to be used for conversion statistics

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Query flow seriesKLAVIYO_QUERY_FLOW_SERIESAcción

Returns the requested flow analytics series data *rate limits*: burst: `1/s` steady: `2/m` daily: `225/d` **scopes:** `flows:read`

Parámetros de entrada

data__typestringenum
Type
flow-series-report
page_cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
data__attributes__filterstring
API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. When filtering on send_channel, allowed values are email, push-notification, sms.
data__attributes__intervalstringenum
The interval used to aggregate data within the series request. If hourly is used, the timeframe cannot be longer than 7 days. If daily is used, the timeframe cannot be longer than 60 days. If monthly is used, the timeframe cannot be longer than 52 weeks.
dailyhourlymonthlyweekly
data__attributes__timeframeobject
The timeframe to query for data within. The max length a timeframe can be is 1 year
data__attributes__statisticsstring[]
List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]
data__attributes__conversion__metric__idstring
ID of the metric to be used for conversion statistics

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Query flow valuesKLAVIYO_QUERY_FLOW_VALUESAcción

Returns the requested flow analytics values data *rate limits*: burst: `1/s` steady: `2/m` daily: `225/d` **scopes:** `flows:read`

Parámetros de entrada

data__typestringenum
Type
flow-values-report
page_cursorstring
For more information please visit https://developers.klaviyo.com/en/v2024-07-15/reference/api-overview#pagination
data__attributes__filterstring
API filter string used to filter the query. Allowed filters are flow_id, send_channel, flow_message_id. Allowed operators are equals, contains-any. Only one filter can be used per attribute, only AND can be used as a combination operator. Max of 100 messages per ANY filter. When filtering on send_channel, allowed values are email, push-notification, sms.
data__attributes__timeframeobject
The timeframe to query for data within. The max length a timeframe can be is 1 year
data__attributes__statisticsstring[]
List of statistics to query for. All rate statistics will be returned in fractional form [0.0, 1.0]
data__attributes__conversion__metric__idstring
ID of the metric to be used for conversion statistics

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Query metric aggregatesKLAVIYO_QUERY_METRIC_AGGREGATESAcción

The klaviyo endpoint fetches metric events, handling json requests for custom data queries, sorting, and filtering; offers grouping and time-based filters; requires adherence to rate limits (3 requests per second, 60 per minute) under 'metrics:read'.

Parámetros de entrada

data__typestringenum
Type
metric-aggregate
data__attributes__bystring[]
Optional attribute(s) used for partitioning by the aggregation function
data__attributes__sortstringenum
Provide a sort key (e.g. -$message)
$attributed_channel-$attributed_channel$attributed_flow-$attributed_flow$attributed_message-$attributed_message$attributed_variation-$attributed_variation$campaign_channel-$campaign_channel$flow-$flow+58
data__attributes__filterstring[]
List of filters, must include time range using ISO 8601 format (YYYY-MM-DDTHH:MM:SS.mmmmmm). These filters follow a similar format to those in `GET` requests, the primary difference is that this endpoint asks for a list. The time range can be filtered by providing a `greater-or-equal` and a `less-than` filter on the `datetime` field.
data__attributes__intervalstringenum
Aggregation interval, e.g. "hour", "day", "week", "month"
dayhourmonthweek
data__attributes__timezonestring
The timezone used for processing the query, e.g. `"America/New_York"`. This field is validated against a list of common timezones from the [IANA Time Zone Database](https://www.iana.org/time-zones). While most are supported, a few notable exceptions are `Factory`, `Europe/Kyiv` and `Pacific/Kanton`. This field is case-sensitive.
data__attributes__metric__idstring
The metric ID used in the aggregation.
data__attributes__page__sizeinteger
Alter the maximum number of returned rows in a single page of aggregation results
data__attributes__measurementsstring[]
Measurement key, e.g. `unique`, `sum_value`, `count`
data__attributes__page__cursorstring
Optional pagination cursor to iterate over large result sets
data__attributes__return__fieldsstring[]
Provide fields to limit the returned data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Profile from ListKLAVIYO_REMOVE_PROFILE_FROM_LISTAcción

Remove profiles from a klaviyo list by profile ids or email addresses. this action removes profiles from a marketing list without affecting their overall consent status. use the unsubscribe profiles action for complete unsubscribing. you can remove up to 1000 profiles per call. rate limits: 10/s burst, 150/m steady. required scopes: `lists:write` and `profiles:write`. preconditions: - either profile ids or emails must be provided (not both) - maximum 1000 profiles per call - email addresses must be valid format - the list must exist and be accessible

Parámetros de entrada

emailsstring[]
List of email addresses to remove from the list (alternative to profile_ids)
list_idstringObligatorio
The ID of the list to remove profiles from
profile_idsstring[]
List of profile IDs to remove from the list (max 1000 per call)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Request profile deletionKLAVIYO_REQUEST_PROFILE_DELETIONAcción

To delete a profile, use only one identifier: email, phone number, or id. requests are asynchronous and can be tracked. ensure legal compliance; refer to docs. rate limits: 3 per second, 60 per minute.

Parámetros de entrada

data__typestringenum
Type
data-privacy-deletion-job
data__attributes__profile__data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__attributes__profile__data__typestringenum
Type
profile
data__attributes__profile__data__attributes__emailstring
Individual"s email address
data__attributes__profile__data__attributes__phone__numberstring
Individual"s phone number in E.164 format

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn bulk profile import jobKLAVIYO_SPAWN_BULK_PROFILE_IMPORT_JOBAcción

Initiate a job to create/update a batch of profiles, up to 10,000 with a max size of 5mb per request. rate limits: 10/s burst, 150/m steady. requires `lists:write` and `profiles:write` scopes. more info in the bulk profile import api guide.

Parámetros de entrada

data__typestringenum
Type
profile-bulk-import-job
data__attributes__profiles__dataobject[]
Data
data__relationships__lists__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn coupon code bulk create jobKLAVIYO_SPAWN_COUPON_CODE_BULK_CREATE_JOBAcción

Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. max number of jobs queued at once we allow for is 100. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `coupon-codes:write`

Parámetros de entrada

data__typestringenum
Type
coupon-code-bulk-create-job
data__attributes__coupon__codes__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn create categories jobKLAVIYO_SPAWN_CREATE_CATEGORIES_JOBAcción

Create bulk job for up to 100 catalog categories with a 5mb size limit and a max of 500 concurrent jobs. rate limits: 75/s burst, 700/m steady. requires 'catalogs:write' scope.

Parámetros de entrada

data__typestringenum
Type
catalog-category-bulk-create-job
data__attributes__categories__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn create items jobKLAVIYO_SPAWN_CREATE_ITEMS_JOBAcción

Create batches of up to 100 catalog items with a 5mb size limit using the bulk job, which allows 500 concurrent jobs. rate limits are 75/s burst and 700/m steady. requires `catalogs:write` scope.

Parámetros de entrada

data__typestringenum
Type
catalog-item-bulk-create-job
data__attributes__items__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn create variants jobKLAVIYO_SPAWN_CREATE_VARIANTS_JOBAcción

Initiate a job to bulk create up to 100 catalog variants, with a 5mb payload size limit. a max of 500 jobs can run concurrently. rate limits are 75/s burst and 700/m steady. requires 'catalogs:write' scope.

Parámetros de entrada

data__typestringenum
Type
catalog-variant-bulk-create-job
data__attributes__variants__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn delete categories jobKLAVIYO_SPAWN_DELETE_CATEGORIES_JOBAcción

Delete multiple catalog categories in bulk, with a limit of 100 per request and a 5mb payload size. a maximum of 500 concurrent jobs permitted. rate limits are 75/s burst and 700/min steady. requires `catalogs:write` scope.

Parámetros de entrada

data__typestringenum
Type
catalog-category-bulk-delete-job
data__attributes__categories__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn delete items jobKLAVIYO_SPAWN_DELETE_ITEMS_JOBAcción

Delete batches of catalog items with a bulk job, max 100 items/request, 5mb size limit, and up to 500 concurrent jobs. rate limits are 75/s burst and 700/m steady. requires `catalogs:write` scope.

Parámetros de entrada

data__typestringenum
Type
catalog-item-bulk-delete-job
data__attributes__items__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn delete variants jobKLAVIYO_SPAWN_DELETE_VARIANTS_JOBAcción

Delete multiple catalog variants with a bulk job, max 100 per request, 5mb size limit. only 500 jobs can run concurrently. rate limits: 75/s burst, 700/m steady. requires `catalogs:write` scope.

Parámetros de entrada

data__typestringenum
Type
catalog-variant-bulk-delete-job
data__attributes__variants__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn update categories jobKLAVIYO_SPAWN_UPDATE_CATEGORIES_JOBAcción

Create a job to bulk update up to 100 categories, with a 5mb size limit and a maximum of 500 concurrent jobs. burst rate limit is 75/s, steady is 700/m. requires `catalogs:write` scope.

Parámetros de entrada

data__typestringenum
Type
catalog-category-bulk-update-job
data__attributes__categories__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn update items jobKLAVIYO_SPAWN_UPDATE_ITEMS_JOBAcción

You can bulk update up to 100 catalog items with a 5mb payload limit. a max of 500 jobs can run concurrently. rate limits are 75 requests/second and 700 requests/minute. required scope: `catalogs:write`.

Parámetros de entrada

data__typestringenum
Type
catalog-item-bulk-update-job
data__attributes__items__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Spawn update variants jobKLAVIYO_SPAWN_UPDATE_VARIANTS_JOBAcción

Create a job to bulk update up to 100 catalog variants with a 5mb payload limit. a max of 500 jobs may run concurrently. rate limits are 75/s burst and 700/m steady. requires `catalogs:write` scope.

Parámetros de entrada

data__typestringenum
Type
catalog-variant-bulk-update-job
data__attributes__variants__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Subscribe profilesKLAVIYO_SUBSCRIBE_PROFILESAcción

The api supports double opt-in for marketing, with 'historical import' bypassing consent. it resets opt-outs for returning users. caps at 1000 profiles, 75/s, and 700/min. needs 'lists:write', 'profiles:write', 'subscriptions:write' permissions.

Parámetros de entrada

data__typestringenum
Type
profile-subscription-bulk-create-job
data__attributes__custom__sourcestring
A custom method detail or source to store on the consent records.
data__attributes__profiles__dataobject[]
Data
data__relationships__list__data__idstring
The list to add the newly subscribed profiles to
data__attributes__historical__importboolean
Whether this subscription is part of a historical import. If true, the consented_at field must be provided for each profile.
data__relationships__list__data__typestringenum
Type
list

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Suppress profilesKLAVIYO_SUPPRESS_PROFILESAcción

Suppress profiles by email, segment, or list id to stop email marketing, regardless of consent. view guides for details. max 100 emails per request, with rate limits of 75/s and 700/m. scopes: profiles:write, subscriptions:write.

Parámetros de entrada

data__typestringenum
Type
profile-suppression-bulk-create-job
data__attributes__profiles__dataobject[]
Data
data__relationships__list__data__idstring
Suppress all profiles in this list
data__relationships__list__data__typestringenum
Type
list
data__relationships__segment__data__idstring
Suppress all profiles in this segment
data__relationships__segment__data__typestringenum
Type
segment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unregister client push tokenKLAVIYO_UNREGISTER_CLIENT_PUSH_TOKENAcción

This endpoint unsubscribes a push token, for use with klaviyo's mobile sdks and a public api key. push notifications must be on. rate limits are 3/s and 60/m.

Parámetros de entrada

company_idstringObligatorio
Your Public API Key / Site ID. See [this article](https://help.klaviyo.com/hc/en-us/articles/115005062267) for more details.
data__typestringenum
Type
push-token-unregister
data__attributes__tokenstring
A push token from APNS or FCM.
data__attributes__vendorstringenum
The vendor of the push token.
apnsfcm
data__attributes__platformstringenum
The platform on which the push token was created.
androidios
data__attributes__profile__data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__attributes__profile__data__typestringenum
Type
profile
data__attributes__profile__data__attributes____kxstring
Also known as the `exchange_id`, this is an encrypted identifier used for identifying a profile by Klaviyo"s web tracking. You can use this field as a filter when retrieving profiles via the Get Profiles endpoint.
data__attributes__profile__data__attributes__emailstring
Individual"s email address
data__attributes__profile__data__attributes__imagestring
URL pointing to the location of a profile image
data__attributes__profile__data__attributes__titlestring
Individual"s job title
data__attributes__profile__data__attributes__last__namestring
Individual"s last name
data__attributes__profile__data__attributes__first__namestring
Individual"s first name
data__attributes__profile__data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__profile__data__attributes__location__ipstring
IP Address
data__attributes__profile__data__attributes__organizationstring
Name of the company or organization within the company for whom the individual works
data__attributes__profile__data__attributes__anonymous__idstring
Id that can be used to identify a profile when other identifiers are not available
data__attributes__profile__data__attributes__location__zipstring
Zip code
data__attributes__profile__data__attributes__phone__numberstring
Individual"s phone number in E.164 format
data__attributes__profile__data__attributes__location__citystring
City name
data__attributes__profile__data__attributes__location__regionstring
Region within a country, such as state or province
data__attributes__profile__data__attributes__location__countrystring
Country name
data__attributes__profile__data__attributes__location__address1string
First line of street address
data__attributes__profile__data__attributes__location__address2string
Second line of street address
data__attributes__profile__data__attributes__location__latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__profile__data__attributes__location__timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
data__attributes__profile__data__meta__patch__properties__unsetstring[]
Remove a key or keys (and their values) completely from properties
data__attributes__profile__data__attributes__location__longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unsubscribe profilesKLAVIYO_UNSUBSCRIBE_PROFILESAcción

Opt-out profiles from email or sms marketing. unsubscribe up to 100 profiles at a time with burst (75/s) and steady (700/m) rate limits. use different method to remove without affecting subscriptions. more on consent and removal in the provided links.

Parámetros de entrada

data__typestringenum
Type
profile-subscription-bulk-delete-job
data__attributes__profiles__dataobject[]
Data
data__relationships__list__data__idstring
The list to remove the profiles from
data__relationships__list__data__typestringenum
Type
list

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Unsuppress profilesKLAVIYO_UNSUPPRESS_PROFILESAcción

Remove 'user suppressed' blocks on profiles manually via email, segment, or list id. does not affect unsubscribes or other suppressions. limits: 100 emails per request, 75/s burst, 700/m steady. scope: 'subscriptions:write'.

Parámetros de entrada

data__typestringenum
Type
profile-suppression-bulk-delete-job
data__attributes__profiles__dataobject[]
Data
data__relationships__list__data__idstring
The list to pull the profiles to remove suppressions from
data__relationships__list__data__typestringenum
Type
list
data__relationships__segment__data__idstring
The segment to pull the profiles to remove suppressions from
data__relationships__segment__data__typestringenum
Type
segment

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update CampaignKLAVIYO_UPDATE_CAMPAIGNAcción

Update a campaign with the specified attributes. this action allows you to modify campaign settings including name, audiences, and send strategy. only the fields you provide will be updated; others remain unchanged. rate limits: 10/s burst, 150/m steady. required scope: `campaigns:write`. preconditions: - valid api key with campaigns:write scope - campaign id must exist and be accessible - campaign must be in a state that allows updates (usually draft status) - send strategy options must match the selected method

Parámetros de entrada

namestring
The campaign name
campaign_idstringObligatorio
The campaign ID to update
send_optionsobject
Additional send options (advanced use)
sto_send_datestring
Date to send on for Smart Send Time (YYYY-MM-DD format)
tracking_optionsobject
Tracking options for the campaign
excluded_audiencesstring[]
List of list/segment IDs to exclude from audiences
included_audiencesstring[]
List of list/segment IDs to include as audiences
throttle_percentageintegerenum
Percentage of recipients to send to per hour
101113141720253350
send_strategy_methodstringenum
Method for sending the campaign
staticthrottledimmediatesmart_send_time
static_send_datetimestringdate-time
When to send the campaign (for static strategy)
throttled_send_datetimestringdate-time
When to start sending the campaign (for throttled strategy)
static_is_local_timezoneboolean
Whether to send in recipients' local timezones
static_send_past_recipients_immediatelyboolean
Whether to send immediately to recipients in past timezones

Parámetros de salida

dataobjectObligatorio
Updated campaign data from Klaviyo
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update campaign messageKLAVIYO_UPDATE_CAMPAIGN_MESSAGEAcción

Update a campaign message *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Parámetros de entrada

idstringObligatorio
The message ID to be retrieved
data__idstring
The message ID to be retrieved
data__typestringenum
Type
campaign-message
data__attributes__labelstring
The label or name on the message
data__attributes__contentobject
Additional attributes relating to the content of the message
data__attributes__render__options__shorten__linksboolean
Shorten Links
data__attributes__render__options__add__info__linkboolean
Add Info Link
data__attributes__render__options__add__org__prefixboolean
Add Org Prefix
data__attributes__render__options__add__opt__out__languageboolean
Add Opt Out Language

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update campaign send jobKLAVIYO_UPDATE_CAMPAIGN_SEND_JOBAcción

Permanently cancel the campaign, setting the status to canceled or revert the campaign, setting the status back to draft *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `campaigns:write`

Parámetros de entrada

idstringObligatorio
The ID of the currently sending campaign to cancel or revert
data__idstring
The ID of the currently sending campaign to cancel or revert
data__typestringenum
Type
campaign-send-job
data__attributes__actionstring
The action you would like to take with this send job from among "cancel" and "revert"

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update catalog categoryKLAVIYO_UPDATE_CATALOG_CATEGORYAcción

Update a catalog category with the given category id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
data__idstring
The catalog category ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
data__typestringenum
Type
catalog-category
data__attributes__namestring
The name of the catalog category.
data__relationships__items__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update catalog category relationships itemsKLAVIYO_UPDATE_CATALOG_CATEGORY_RELATIONSHIPS_ITEMSAcción

Update item relationships for the given category id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update catalog itemKLAVIYO_UPDATE_CATALOG_ITEMAcción

Update a catalog item with the given item id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
data__idstring
The catalog item ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
data__typestringenum
Type
catalog-item
data__attributes__urlstring
URL pointing to the location of the catalog item on your website.
data__attributes__priceinteger
This field can be used to set the price on the catalog item, which is what gets displayed for the item when included in emails. For most price-update use cases, you will also want to update the `price` on any child variants, using the [Update Catalog Variant Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_variant).
data__attributes__titlestring
The title of the catalog item.
data__attributes__imagesstring[]
List of URLs pointing to the locations of images of the catalog item.
data__attributes__publishedboolean
Boolean value indicating whether the catalog item is published.
data__attributes__descriptionstring
A description of the catalog item.
data__attributes__image__full__urlstring
URL pointing to the location of a full image of the catalog item.
data__relationships__categories__dataobject[]
Data
data__attributes__image__thumbnail__urlstring
URL pointing to the location of an image thumbnail of the catalog item

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update catalog item relationships categoriesKLAVIYO_UPDATE_CATALOG_ITEM_RELATIONSHIPS_CATEGORIESAcción

Update catalog category relationships for the given item id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
dataobject[]Obligatorio
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update catalog variantKLAVIYO_UPDATE_CATALOG_VARIANTAcción

Update a catalog item variant with the given variant id. *rate limits*: burst: `75/s` steady: `700/m` **scopes:** `catalogs:write`

Parámetros de entrada

idstringObligatorio
The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
data__idstring
The catalog variant ID is a compound ID (string), with format: `{integration}:::{catalog}:::{external_id}`. Currently, the only supported integration type is `$custom`, and the only supported catalog is `$default`.
data__typestringenum
Type
catalog-variant
data__attributes__skustring
The SKU of the catalog item variant.
data__attributes__urlstring
URL pointing to the location of the catalog item variant on your website.
data__attributes__priceinteger
This field can be used to set the price on the catalog item variant, which is what gets displayed for the item variant when included in emails. For most price-update use cases, you will also want to update the `price` on any parent items using the [Update Catalog Item Endpoint](https://developers.klaviyo.com/en/reference/update_catalog_item).
data__attributes__titlestring
The title of the catalog item variant.
data__attributes__imagesstring[]
List of URLs pointing to the locations of images of the catalog item variant.
data__attributes__publishedboolean
Boolean value indicating whether the catalog item variant is published.
data__attributes__descriptionstring
A description of the catalog item variant.
data__attributes__image__full__urlstring
URL pointing to the location of a full image of the catalog item variant.
data__attributes__inventory__policyinteger
This field controls the visibility of this catalog item variant in product feeds/blocks. This field supports the following values: `1`: a product will not appear in dynamic product recommendation feeds and blocks if it is out of stock. `0` or `2`: a product can appear in dynamic product recommendation feeds and blocks regardless of inventory quantity.
data__attributes__inventory__quantityinteger
The quantity of the catalog item variant currently in stock.
data__attributes__image__thumbnail__urlstring
URL pointing to the location of an image thumbnail of the catalog item variant.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update couponKLAVIYO_UPDATE_COUPONAcción

*rate limits*: burst: `3/s` steady: `60/m` **scopes:** `coupons:write`

Parámetros de entrada

idstringObligatorio
The internal id of a Coupon is equivalent to its external id stored within an integration.
data__idstring
The internal id of a Coupon is equivalent to its external id stored within an integration.
data__typestringenum
Type
coupon
data__attributes__descriptionstring
A description of the coupon.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update coupon codeKLAVIYO_UPDATE_COUPON_CODEAcción

Updates a coupon code specified by the given identifier synchronously. we allow updating the 'status' and 'expires at' of coupon codes. *rate limits*: burst: `350/s` steady: `3500/m` **scopes:** `coupon-codes:write`

Parámetros de entrada

idstringObligatorio
The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
data__idstring
The id of a coupon code is a combination of its unique code and the id of the coupon it is associated with.
data__typestringenum
Type
coupon-code
data__attributes__statusstringenum
The API status of our coupon codes.
ASSIGNED_TO_PROFILEDELETINGPROCESSINGUNASSIGNEDUSEDVERSION_NOT_ACTIVE
data__attributes__expires__atstringdate-time
The datetime when this coupon code will expire. If not specified or set to null, it will be automatically set to 1 year.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update flow statusKLAVIYO_UPDATE_FLOW_STATUSAcción

Update the status of a flow with the given flow id, and all actions in that flow. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `flows:write`

Parámetros de entrada

idstringObligatorio
ID of the Flow to update. Ex: XVTP5Q
data__idstring
ID of the Flow to update. Ex: XVTP5Q
data__typestringenum
Type
flow
data__attributes__statusstring
Status you want to update the flow to. ["draft", "manual", or "live"]

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update imageKLAVIYO_UPDATE_IMAGEAcción

Update the image with the given image id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `images:write`

Parámetros de entrada

idstringObligatorio
The ID of the image
data__idstring
The ID of the image
data__typestringenum
Type
image
data__attributes__namestring
A name for the image.
data__attributes__hiddenboolean
If true, this image is not shown in the asset library.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update listKLAVIYO_UPDATE_LISTAcción

Update the name of a list with the given list id. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `lists:write`

Parámetros de entrada

idstringObligatorio
Primary key that uniquely identifies this list. Generated by Klaviyo.
data__idstring
Primary key that uniquely identifies this list. Generated by Klaviyo.
data__typestringenum
Type
list
data__attributes__namestring
A helpful name to label the list

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update profileKLAVIYO_UPDATE_PROFILEAcción

Update profiles with the provided id. setting fields to `null` clears them; omitting fields retains existing data. rate limits: 75/s burst, 700/m steady. required scope: `profiles:write`.

Parámetros de entrada

idstringObligatorio
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__idstring
Primary key that uniquely identifies this profile. Generated by Klaviyo.
data__typestringenum
Type
profile
data__attributes__emailstring
Individual"s email address
data__attributes__imagestring
URL pointing to the location of a profile image
data__attributes__titlestring
Individual"s job title
data__attributes__last__namestring
Individual"s last name
data__attributes__first__namestring
Individual"s first name
data__attributes__external__idstring
A unique identifier used by customers to associate Klaviyo profiles with profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
data__attributes__location__ipstring
IP Address
data__attributes__organizationstring
Name of the company or organization within the company for whom the individual works
data__attributes__anonymous__idstring
Anonymous Id
data__attributes__location__zipstring
Zip code
data__attributes__phone__numberstring
Individual"s phone number in E.164 format
data__attributes__location__citystring
City name
data__attributes__location__regionstring
Region within a country, such as state or province
data__attributes__location__countrystring
Country name
data__attributes__location__address1string
First line of street address
data__attributes__location__address2string
Second line of street address
data__attributes__location__latitudestring
Latitude coordinate. We recommend providing a precision of four decimal places.
data__attributes__location__timezonestring
Time zone name. We recommend using time zones from the IANA Time Zone Database.
data__meta__patch__properties__unsetstring[]
Remove a key or keys (and their values) completely from properties
data__attributes__location__longitudestring
Longitude coordinate. We recommend providing a precision of four decimal places.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update segmentKLAVIYO_UPDATE_SEGMENTAcción

Update a segment with the given segment id. *rate limits*: burst: `1/s` steady: `15/m` daily: `100/d` **scopes:** `segments:write`

Parámetros de entrada

idstringObligatorio
data__idstring
Id
data__typestringenum
Type
segment
data__attributes__namestring
Name
data__attributes__is__starredboolean
Is Starred
data__attributes__definition__condition__groupsobject[]
Condition Groups

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update tagKLAVIYO_UPDATE_TAGAcción

Update the tag with the given tag id. only a tag's `name` can be changed. a tag cannot be moved from one tag group to another. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read` `tags:write`

Parámetros de entrada

idstringObligatorio
The Tag ID
data__idstring
The Tag ID
data__typestringenum
Type
tag
data__attributes__namestring
The Tag name

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update tag groupKLAVIYO_UPDATE_TAG_GROUPAcción

Update the tag group with the given tag group id. only a tag group's `name` can be changed. a tag group's `exclusive` or `default` value cannot be changed. *rate limits*: burst: `3/s` steady: `60/m` **scopes:** `tags:read` `tags:write`

Parámetros de entrada

idstringObligatorio
The Tag Group ID
data__idstring
The Tag Group ID
data__typestringenum
Type
tag-group
data__attributes__namestring
The Tag Group name
data__attributes__return__fieldsstring[]
Return Fields

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update templateKLAVIYO_UPDATE_TEMPLATEAcción

Update a template with the given template id. does not currently update drag & drop templates. *rate limits*: burst: `10/s` steady: `150/m` **scopes:** `templates:write`

Parámetros de entrada

idstringObligatorio
The ID of template
data__idstring
The ID of template
data__typestringenum
Type
template
data__attributes__htmlstring
The HTML of the template
data__attributes__namestring
The name of the template
data__attributes__textstring
The plaintext of the template

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update webhookKLAVIYO_UPDATE_WEBHOOKAcción

Update the webhook with the given id. *rate limits*: burst: `1/s` steady: `15/m` **scopes:** `webhooks:write`

Parámetros de entrada

idstringObligatorio
The ID of the webhook.
data__idstring
The ID of the webhook.
data__typestringenum
Type
webhook
data__attributes__namestring
A name for the webhook.
data__attributes__enabledboolean
Is the webhook enabled.
data__attributes__descriptionstring
A description for the webhook.
data__attributes__secret__keystring
A secret key, that will be used for webhook request signing.
data__attributes__endpoint__urlstring
A url to send webhook calls to. Must be https.
data__relationships__webhook__topics__dataobject[]
Data

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload image from fileKLAVIYO_UPLOAD_IMAGE_FROM_FILEAcción

Upload an image from a file. if you want to import an image from an existing url or a data uri, use the upload image from url endpoint instead. *rate limits*: burst: `3/s` steady: `100/m` daily: `100/d` **scopes:** `images:write`

Parámetros de entrada

fileobjectbinary
File
namestring
Name
hiddenboolean
Hidden

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Upload image from urlKLAVIYO_UPLOAD_IMAGE_FROM_URLAcción

Import an image from a url or data uri. if you want to upload an image from a file, use the upload image from file endpoint instead. *rate limits*: burst: `3/s` steady: `100/m` daily: `100/d` **scopes:** `images:write`

Parámetros de entrada

data__typestringenum
Type
image
data__attributes__namestring
A name for the image. Defaults to the filename if not provided. If the name matches an existing image, a suffix will be added.
data__attributes__hiddenboolean
If true, this image is not shown in the asset library.
data__attributes__import__from__urlstring
An existing image url to import the image from. Alternatively, you may specify a base-64 encoded data-uri (`data:image/...`). Supported image formats: jpeg,png,gif. Maximum image size: 5MB.

Parámetros de salida

dataobjectObligatorio
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not