Klaviyo integration

Get account

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

Get accounts

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`.

Get bulk profile import job

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

Get bulk profile import job errors

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

Get bulk profile import job lists

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

Get bulk profile import job profiles

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

Get bulk profile import job relationships lists

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

Get bulk profile import job relationships profiles

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

Get bulk profile import jobs

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

Get campaign

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

Get campaign campaign messages

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

Get campaign message

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

Add profile to list

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

Assign campaign message template

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

Bulk create client events

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.

Bulk create events

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`.

Create back in stock subscription

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.

Create campaign

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

Create campaign clone

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

Create campaign recipient estimation job

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

Create campaign send job

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

Create catalog category

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

Create catalog category relationships items

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

Create catalog item

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