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
231 actionsSign in with Klaviyo
What your bot can do in Klaviyo
Looks up
- Get CampaignRetrieve a specific campaign by its id from klaviyo.
- Get CampaignsRetrieve campaigns from your klaviyo account.
- Get eventsGet all events in an account requests can be sorted by the following fields.
- Get ListsRetrieve marketing lists from your klaviyo account.
- Get ProfilesRetrieve profiles from your klaviyo account.
- Create template renderRender an email template with specific context and sparse fieldsets, then get html/plain text.
- Get accountRetrieve a single account object by its account id.
- Get accountsUse a private api key to fetch an associated account's details like contact info, timezone, and currency, as well as validate the key.
- Get bulk profile import jobGet a bulk profile import job with the given job id.<br><br>*rate limits*.
- Get bulk profile import job errorsGet import errors for the bulk profile import job with the given id.<br><br>*rate limits*.
Show 126 more
- Get bulk profile import job listsGet list for the bulk profile import job with the given id.<br><br>*rate limits*.
- Get bulk profile import job profilesGet profiles for the bulk profile import job with the given id.<br><br>*rate limits*.
- Get bulk profile import job relationships listsGet list relationship for the bulk profile import job with the given id.<br><br>*rate limits*.
- Get bulk profile import job relationships profilesGet profile relationships for the bulk profile import job with the given id.<br><br>*rate limits*.
- Get bulk profile import jobsGet all bulk profile import jobs.
- Get campaign campaign messagesReturn all messages that belong to the given campaign.<br><br>*rate limits*.
- Get campaign messageReturns a specific message based on a required id.<br><br>*rate limits*.
- Get campaign message campaignReturn the related campaign<br><br>*rate limits*.
- Get campaign message relationships campaignReturns the id of the related campaign<br><br>*rate limits*.
- Get campaign message relationships templateReturns the id of the related template<br><br>*rate limits*.
- Get campaign message templateReturn the related template<br><br>*rate limits*.
- Get campaign recipient estimationGet estimated recipients for a given campaign id using create campaign recipient estimation job.
- Get campaign recipient estimation jobRetrieve the status of a recipient estimation job triggered with the create campaign recipient estimation job endpoint.<br><br>*rate…
- Get campaign relationships campaign messagesReturns the ids of all messages associated with the given campaign.<br><br>*rate limits*.
- Get campaign relationships tagsReturns the ids of all tags associated with the given campaign.<br><br>*rate limits*.
- Get campaign send jobGet a campaign send job<br><br>*rate limits*.
- Get campaign tagsReturn all tags that belong to the given campaign.<br><br>*rate limits*.
- Get catalog categoriesRetrieve up to 100 account catalog categories, sortable by creation date.
- Get catalog categoryGet a catalog category with the given category id.<br><br>*rate limits*.
- Get catalog category itemsRetrieve up to 100 sorted items per request from a category using the category id.
- Get catalog category relationships itemsGet all items in the given category id.
- Get catalog itemGet a specific catalog item with the given item id.<br><br>*rate limits*.
- Get catalog item categoriesRetrieve the catalog categories for an item by id, sorted by 'created' date, with a 100-category maximum per request.
- Get catalog item relationships categoriesGet all catalog categories that a particular item is in.
- Get catalog item variantsRetrieve up to 100 variants per request for a specific item id, sortable by creation date.
- Get catalog itemsRetrieve up to 100 sorted catalog items per account, with $custom integration and $default type.
- Get catalog variantGet a catalog item variant with the given variant id.<br><br>*rate limits*.
- Get catalog variantsRetrieve up to 100 account variants per request, sortable by creation date.
- Get couponGet a specific coupon with the given coupon id.<br><br>*rate limits*.
- Get coupon codeReturns a coupon code specified by the given identifier.<br><br>*rate limits*.
- Get coupon code bulk create jobGet a coupon code bulk create job with the given job id.<br><br>*rate limits*.
- Get coupon code bulk create jobsGet all coupon code bulk create jobs.
- Get coupon code relationships couponGets a list of coupon code relationships associated with the given coupon id<br><br>*rate limits*.
- Get coupon codesObtains coupon codes using necessary coupon or profile filters.
- Get coupon codes for couponGets a list of coupon codes associated with the given coupon id<br><br>*rate limits*.
- Get coupon for coupon codeGet the coupon associated with a given coupon code id.<br><br>*rate limits*.
- Get coupon relationships coupon codesGets the coupon relationship associated with the given coupon code id<br><br>*rate limits*.
- Get couponsGet all coupons in an account.
- Get create categories jobGet a catalog category bulk create job with the given job id.
- Get create categories jobsGet all catalog category bulk create jobs.
- Get create items jobGet a catalog item bulk create job with the given job id.
- Get create items jobsGet all catalog item bulk create jobs.
- Get create variants jobGet a catalog variant bulk create job with the given job id.
- Get create variants jobsGet all catalog variant bulk create jobs.
- Get delete categories jobGet a catalog category bulk delete job with the given job id.<br><br>*rate limits*.
- Get delete categories jobsGet all catalog category bulk delete jobs.
- Get delete items jobGet a catalog item bulk delete job with the given job id.<br><br>*rate limits*.
- Get delete items jobsGet all catalog item bulk delete jobs.
- Get delete variants jobGet a catalog variant bulk delete job with the given job id.<br><br>*rate limits*.
- Get delete variants jobsGet all catalog variant bulk delete jobs.
- Get eventGet an event with the given event id.<br><br>*rate limits*.
- Get event metricGet the metric for an event with the given event id.<br><br>*rate limits*.
- Get event profileGet the profile associated with an event with the given event id.<br><br>*rate limits*.
- Get event relationships metricGet a list of related metrics for an event<br><br>*rate limits*.
- Get event relationships profileGet profile [relationships](https.
- Get flowGet a flow with the given flow id.<br><br>*rate limits*.
- Get flow actionGet a flow action from a flow with the given flow action id.<br><br>*rate limits*.
- Get flow action for messageGet the flow action for a flow message with the given message id.<br><br>*rate limits*.
- Get flow action messagesRetrieve up to 50 flow messages per request by action id, sortable by various fields, with ascending/descending options, and paginated…
- Get flow action relationships flowGet the flow associated with the given action id.<br><br>*rate limits*.
- Get flow action relationships messagesRetrieves up to 50 flow message relationships per request for a specified flow action id, with cursor pagination.
- Get flow flow actionsGet all flow actions associated with the given flow id.
- Get flow for flow actionGet the flow associated with the given action id.<br><br>*rate limits*.
- Get flow messageGet the flow message of a flow with the given message id.<br><br>*rate limits*.
- Get flow message relationships actionGet the [relationship](https.
- Get flow message relationships templateReturns the id of the related template<br><br>*rate limits*.
- Get flow message templateReturn the related template<br><br>*rate limits*.
- Get flow relationships flow actionsRetrieve all flow action relationships for a specific flow id, sortable by id, status, created, updated.
- Get flow relationships tagsReturn the tag ids of all tags associated with the given flow.<br><br>*rate limits*.
- Get flow tagsReturn all tags associated with the given flow id.<br><br>*rate limits*.
- Get flowsGet all flows in an account.
- Get formGet the form with the given id.<br><br>*rate limits*.
- Get form for form versionGet the form associated with the given form version.<br><br>*rate limits*.
- Get form id for form versionGet the id of the form associated with the given form version.<br><br>*rate limits*.
- Get form versionGet the form version with the given id.<br><br>*rate limits*.
- Get formsGet all forms in an account.<br><br>*rate limits*.
- Get imageGet the image with the given image id.<br><br>*rate limits*.
- Get imagesGet all images in an account.<br><br>*rate limits*.
- Get listApi allows 75 req/sec and 700 req/min, but with 'profile count' param, it's 1 req/sec and 15 req/min.
- Get list profilesRetrieve profiles in a list by id, filterable by email/phone/push token/join date, sortable by join date.
- Get list relationships profilesGet profile membership [relationships](https.
- Get list relationships tagsReturns the tag ids of all tags associated with the given list.<br><br>*rate limits*.
- Get list tagsReturn all tags associated with the given list id.<br><br>*rate limits*.
- Get metricGet a metric with the given metric id.<br><br>*rate limits*.
- Get metricsGet all metrics in an account.
- Get profileGet the profile with the given profile id.<br><br>*rate limits*.
- Get profile listsGet list memberships for a profile with the given profile id.<br><br>*rate limits*.
- Get profile relationships listsGet list memberships for a profile with the given profile id.<br><br>*rate limits*.
- Get profile relationships segmentsGet segment membership relationships for a profile with the given profile id.<br><br>*rate limits*.
- Get profile segmentsGet segment memberships for a profile with the given profile id.<br><br>*rate limits*.
- Get segmentFetch a segment by id with default rates of 75/s and 700/m, or with additional-fields at 1/s and 15/m.
- Get segment profilesRetrieve profiles in a segment by id, filtering by email, phone, token, or join date, and sorting by join date.
- Get segment relationships profilesGet all profile membership [relationships](https.
- Get segment relationships tagsIf related resource is tags, returns the tag ids of all tags associated with the given segment id.<br><br>*rate limits*.
- Get segment tagsReturn all tags associated with the given segment id.<br><br>*rate limits*.
- Get segmentsFetch segments from an account with filters like name, created, and updated.
- Get tagRetrieve the tag with the given tag id.<br><br>*rate limits*.
- Get tag groupRetrieve the tag group with the given tag group id.<br><br>*rate limits*.
- Get tag group relationships tagsReturns the tag ids of all tags inside the given tag group.<br><br>*rate limits*.
- Get tag group tagsReturn the tags for a given tag group id.<br><br>*rate limits*.
- Get tag groupsRetrieve up to 25 tag groups per account, sortable/filterable by specific attributes.
- Get tag relationships campaignsReturns the ids of all campaigns associated with the given tag.<br><br>*rate limits*.
- Get tag relationships flowsReturns the ids of all flows associated with the given tag.<br><br>*rate limits*.
- Get tag relationships listsReturns the ids of all lists associated with the given tag.<br><br>*rate limits*.
- Get tag relationships segmentsReturns the ids of all segments associated with the given tag.<br><br>*rate limits*.
- Get tag relationships tag groupReturns the id of the tag group related to the given tag.<br><br>*rate limits*.
- Get tag tag groupReturns the tag group resource for a given tag id.<br><br>*rate limits*.
- Get tagsRetrieve up to 50 account tags at once, filterable/sortable by name or id, with cursor pagination.
- Get templateGet a template with the given template id.<br><br>*rate limits*.
- Get templatesRetrieve account templates with sorting options (id, name, created, updated).
- Get update categories jobGet a catalog category bulk update job with the given job id.
- Get update categories jobsGet all catalog category bulk update jobs.
- Get update items jobGet a catalog item bulk update job with the given job id.
- Get update items jobsGet all catalog item bulk update jobs.
- Get update variants jobGet a catalog variate bulk update job with the given job id.
- Get update variants jobsGet all catalog variant bulk update jobs.
- Get version ids for formGet the ids of the form versions for the given form.<br><br>*rate limits*.
- Get versions for formGet the form versions for the given form.<br><br>*rate limits*.
- Get webhookGet the webhook with the given id.<br><br>*rate limits*.
- Get webhook topicGet the webhook topic with the given id.<br><br>*rate limits*.
- Get webhook topicsGet all webhook topics in a klaviyo account.<br><br>*rate limits*.
- Get webhooksGet all webhooks in an account.<br><br>*rate limits*.
- Query campaign valuesReturns the requested campaign analytics values data<br><br>*rate limits*.
- Query flow seriesReturns the requested flow analytics series data<br><br>*rate limits*.
- Query flow valuesReturns the requested flow analytics values data<br><br>*rate limits*.
- Query metric aggregatesThe klaviyo endpoint fetches metric events, handling json requests for custom data queries, sorting, and filtering.
Takes action
- Add Profile to ListAdd profiles to a klaviyo list by profile ids or email addresses.
- Create Campaign Recipient Estimation JobStart an asynchronous task to estimate the number of recipients for a campaign.
- Create eventCreate or update a profile event with minimum identifiers and metric name.
- Create listCreate a new list.<br><br>*rate limits*.
- Create or Update ProfileCreate or update a profile in klaviyo with the given attributes.
- Create profileCreate a new profile.<br><br>*rate limits*.
- Update CampaignUpdate a campaign with the specified attributes.
- Assign campaign message templateCreates a non-reusable version of the template and assigns it to the message.<br><br>*rate limits*.
- Bulk create client eventsUse the client-side endpoint with a public api key to track profile activity.
- Bulk create eventsThis api endpoint creates or updates profiles by batching up to 1,000 events, with a 5mb payload limit.
Show 85 more
- Create back in stock subscriptionUse the server-side endpoint to subscribe to restock alerts, following the back in stock api guide.
- Create campaignCreates a campaign given a set of parameters, then returns it.<br><br>*rate limits*.
- Create campaign cloneClones an existing campaign, returning a new campaign based on the original with a new id and name.<br><br>*rate limits*.
- Create campaign send jobTrigger a campaign to send asynchronously<br><br>*rate limits*.
- Create catalog categoryCreate a new catalog category.<br><br>*rate limits*.
- Create catalog category relationships itemsCreate a new item relationship for the given category id.<br><br>*rate limits*.
- Create catalog itemCreate a new catalog item.<br><br>*rate limits*.
- Create catalog item relationships categoriesCreate a new catalog category relationship for the given item id.<br><br>*rate limits*.
- Create catalog variantCreate a new variant for a related catalog item.<br><br>*rate limits*.
- Create client back in stock subscriptionUse the endpoint for client-side back in stock notifications with a public api key.
- Create client eventCreate client-side events to track profiles using a public api key, not for updating identifiers (server-side only).
- Create client subscriptionEndpoint manages email/sms opt-ins using consent and requires public api key for client use.
- Create couponCreates a new coupon.<br><br>*rate limits*.
- Create coupon codeSynchronously creates a coupon code for the given coupon.<br><br>*rate limits*.
- Create or update client profileUpdate user profiles without tracking using a public client-side api.
- Create or update client push tokenThis endpoint for mobile sdks (ios & android) creates/updates push tokens using a public api key.
- Create or update push tokenMigrate or create push tokens with klaviyo's endpoint, utilizing their mobile sdks for ios & android.
- Create segmentCreate a segment.<br><br>*rate limits*.
- Create tagSummary.
- Create tag groupCreate tag groups up to 50 per account, defaulting to non-exclusive unless specified.
- Create tag relationships campaignsSummary.
- Create tag relationships flowsAssign tags to flows using their ids in the request body, ensuring a flow is not linked to over 100 tags.
- Create tag relationships listsSummary.
- Create tag relationships segmentsSummary.
- Create templateSummary.
- Create template cloneClone a template by its id, but cloning fails if account has 1,000+ templates.
- Create webhookCreate a new webhook<br><br>*rate limits*.
- Delete campaignDelete a campaign with the given campaign id.<br><br>*rate limits*.
- Delete catalog categoryDelete a catalog category using the given category id.<br><br>*rate limits*.
- Delete catalog category relationships itemsDelete item relationships for the given category id.<br><br>*rate limits*.
- Delete catalog itemDelete a catalog item with the given item id.<br><br>*rate limits*.
- Delete catalog item relationships categoriesDelete catalog category relationships for the given item id.<br><br>*rate limits*.
- Delete catalog variantDelete a catalog item variant with the given variant id.<br><br>*rate limits*.
- Delete couponDelete the coupon with the given coupon id.<br><br>*rate limits*.
- Delete coupon codeDeletes a coupon code specified by the given identifier synchronously.
- Delete flowDelete a flow with the given flow id.<br><br>*rate limits*.
- Delete listDelete a list with the given list id.<br><br>*rate limits*.
- Delete segmentDelete a segment with the given segment id.<br><br>*rate limits*.
- Delete tagDelete the tag with the given tag id.
- Delete tag groupDelete a specified tag group and its contents.
- Delete tag relationships campaignsDisconnect a tag from campaigns using the campaign id(s) in the request body.
- Delete tag relationships flowsRemove a tag's association with one or more flows.
- Delete tag relationships listsRemove a tag's association with one or more lists.
- Delete tag relationships segmentsUse the request body to de-associate a tag from specified segment ids.
- Delete templateDelete a template with the given template id.<br><br>*rate limits*.
- Delete webhookDelete a webhook with the given id.<br><br>*rate limits*.
- Merge profilesQueue a task to merge one source profile into a destination profile using their ids.
- Remove Profile from ListRemove profiles from a klaviyo list by profile ids or email addresses.
- Request profile deletionTo delete a profile, use only one identifier.
- Spawn bulk profile import jobInitiate a job to create/update a batch of profiles, up to 10,000 with a max size of 5mb per request.
- Spawn coupon code bulk create jobCreate a coupon-code-bulk-create-job to bulk create a list of coupon codes.
- Spawn create categories jobCreate bulk job for up to 100 catalog categories with a 5mb size limit and a max of 500 concurrent jobs.
- Spawn create items jobCreate batches of up to 100 catalog items with a 5mb size limit using the bulk job, which allows 500 concurrent jobs.
- Spawn create variants jobInitiate a job to bulk create up to 100 catalog variants, with a 5mb payload size limit.
- Spawn delete categories jobDelete multiple catalog categories in bulk, with a limit of 100 per request and a 5mb payload size.
- Spawn delete items jobDelete batches of catalog items with a bulk job, max 100 items/request, 5mb size limit, and up to 500 concurrent jobs.
- Spawn delete variants jobDelete multiple catalog variants with a bulk job, max 100 per request, 5mb size limit.
- Spawn update categories jobCreate a job to bulk update up to 100 categories, with a 5mb size limit and a maximum of 500 concurrent jobs.
- Spawn update items jobYou can bulk update up to 100 catalog items with a 5mb payload limit.
- Spawn update variants jobCreate a job to bulk update up to 100 catalog variants with a 5mb payload limit.
- Subscribe profilesThe api supports double opt-in for marketing, with 'historical import' bypassing consent.
- Suppress profilesSuppress profiles by email, segment, or list id to stop email marketing, regardless of consent.
- Unregister client push tokenThis endpoint unsubscribes a push token, for use with klaviyo's mobile sdks and a public api key.
- Unsubscribe profilesOpt-out profiles from email or sms marketing.
- Unsuppress profilesRemove 'user suppressed' blocks on profiles manually via email, segment, or list id.
- Update campaign messageUpdate a campaign message<br><br>*rate limits*.
- Update campaign send jobPermanently cancel the campaign, setting the status to canceled or revert the campaign, setting the status back to draft<br><br>*rate…
- Update catalog categoryUpdate a catalog category with the given category id.<br><br>*rate limits*.
- Update catalog category relationships itemsUpdate item relationships for the given category id.<br><br>*rate limits*.
- Update catalog itemUpdate a catalog item with the given item id.<br><br>*rate limits*.
- Update catalog item relationships categoriesUpdate catalog category relationships for the given item id.<br><br>*rate limits*.
- Update catalog variantUpdate a catalog item variant with the given variant id.<br><br>*rate limits*.
- Update coupon*rate limits*.
- Update coupon codeUpdates a coupon code specified by the given identifier synchronously.
- Update flow statusUpdate the status of a flow with the given flow id, and all actions in that flow.<br><br>*rate limits*.
- Update imageUpdate the image with the given image id.<br><br>*rate limits*.
- Update listUpdate the name of a list with the given list id.<br><br>*rate limits*.
- Update profileUpdate profiles with the provided id.
- Update segmentUpdate a segment with the given segment id.<br><br>*rate limits*.
- Update tagUpdate the tag with the given tag id.
- Update tag groupUpdate the tag group with the given tag group id.
- Update templateUpdate a template with the given template id.
- Update webhookUpdate the webhook with the given id.<br><br>*rate limits*.
- Upload image from fileUpload an image from a file.
- Upload image from urlImport an image from a url or data uri.