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
225
Available Tools
0
Triggers
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
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`
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 for multiple profiles in a single request. Accepts up to 1,000 events with a 5MB max payload. Each event requires a profile identifier (email, phone_number, or external_id) and a metric name. Events are processed asynchronously; a 202 response indicates acceptance, not completion. Rate limits: 10/s burst, 150/min steady.
Cancel or revert a campaign send job. Use 'cancel' to permanently stop a campaign (status becomes CANCELED), or 'revert' to return it to DRAFT for editing. This action modifies a campaign send job that is currently queued or sending. The cancel action is irreversible and sets the status to CANCELED. The revert action returns the campaign to DRAFT status, allowing further modifications. Rate limits: 10/s burst, 150/m steady. Required scope: `campaigns:write`. Preconditions: - Valid API key with campaigns:write scope - Campaign send job ID must exist and be accessible - Campaign must be in a state that allows cancellation (queued or sending)
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.
Get create categories job
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
Get create categories jobs
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
Get create items job
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
Get create items jobs
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
Get create variants job
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
Get create variants jobs
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
Get delete categories job
Get a catalog category bulk delete job with the given job ID.
Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read
Get delete categories jobs
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
Get delete items jobs
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
Get delete variants job
Get a catalog variant bulk delete job with the given job ID.
Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: catalogs:read
Get delete variants jobs
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
Get event
Get an event with the given event ID.
Rate limits:
Burst: 10/s
Steady: 150/m Scopes: events:read
Get event metric
Get the metric for an event with the given event ID.
Rate limits:
Burst: 350/s
Steady: 3500/m Scopes: events:read metrics:read
Get event profile
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
Get Event Relationships
Get metrics or profile relationships for a specific event. Use when you need to retrieve the metric or profile associated with an event. Rate limits: 350/s burst, 3500/m steady. Required scopes: Events Read, Metrics Read, Profiles Read.
Get events
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
Get flow
Get a flow with the given flow ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read
Get flow action
Get a flow action from a flow with the given flow action ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read
Get flow action for message
Get the flow action for a flow message with the given message ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read
Get flow action messages
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.
Get Parent Flow for Flow Action
Get the parent flow associated with a given flow action ID. This endpoint returns the flow relationship data for a specific flow action, allowing you to identify which flow contains the specified action. Use cases: - Determine which flow a specific action belongs to - Navigate from an action to its parent flow Rate limits: Burst: 3/s, Steady: 60/m Required scope: flows:read
Get flow action relationships messages
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.
Get flow flow actions
Get all flow actions associated with the given flow ID. Returns a maximum of 50 flow actions per request, which can be paginated with cursor-based pagination.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read
Get flow for flow action
Get the flow associated with the given action ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read
Get flow message
Get the flow message of a flow with the given message ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read
Get flow message relationships action
Get the flow action relationship for a specific flow message. This returns the parent flow action that contains the specified flow message (e.g., the SEND_EMAIL or SEND_SMS action). Requires a valid flow message ID which can be obtained from GET /api/flow-actions/{id}/flow-messages/. Rate limits: Burst 3/s, Steady 60/m. Required scope: flows:read
Get flow message relationships template
Returns the ID of the related template
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: templates:read
Get flow message template
Return the related template
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: templates:read
Get flow relationships flow actions
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.
Get flow relationships tags
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
Get flows
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
Get flow tags
Return all tags associated with the given flow ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: flows:read tags:read
Get form
Get the form with the given ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read
Get form for form version
Get the form associated with the given form version.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read
Get form id for form version
Get the ID of the form associated with the given form version.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read
Get forms
Get all forms in an account.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read
Get form version
Retrieve detailed information about a specific form version by its ID. Form versions represent different variations of a Klaviyo sign-up form. A form may have multiple versions for A/B testing (multiple live variations) or draft/live combinations during editing. Use this endpoint to get the full configuration including form type, status, steps, styling, triggers, and other settings. Rate limits: Burst 3/s, Steady 60/m. Required scope: forms:read
Get image
Get the image with the given image ID.
Rate limits:
Burst: 10/s
Steady: 150/m Scopes: images:read
Get images
Get all images in an account.
Rate limits:
Burst: 10/s
Steady: 150/m Scopes: images:read
Get list
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.
Get list profiles
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.
Get List Relationships
Get profile membership relationships for a Klaviyo list. Returns references (IDs) to profiles that are members of the specified list. Use when you need to retrieve which profiles belong to a list without fetching full profile data.
Get list relationships tags
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
Get Lists
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
Get list tags
Return all tags associated with the given list ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: lists:read tags:read
Get metric
Get a metric with the given metric ID.
Rate limits:
Burst: 10/s
Steady: 150/m Scopes: metrics:read
Get metrics
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
Get profile
Get the profile with the given profile ID.
Rate limits:
Burst: 75/s
Steady: 700/m Scopes: profiles:read
Get profile lists
Get list memberships for a profile with the given profile ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: lists:read profiles:read
Get Profile Relationships
Tool to get list membership or segment membership relationships for a profile with the given profile ID. Use when you need to determine which lists or segments a specific profile belongs to.
Get Profiles
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
Get profile segments
Get segment memberships for a profile with the given profile ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: profiles:read segments:read
Get segment
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.
Get segment profiles
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.
Get Segment Relationships
Get all profile membership or tag relationships for a segment. Use 'profiles' to retrieve profile membership relationships or 'tags' to retrieve tag associations. Rate limits: Burst 75/s, Steady 700/m. Required scopes: profiles:read, segments:read.
Get segments
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.
Get segment tags
Return all tags associated with the given segment ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: segments:read tags:read
Get tag
Retrieve the tag with the given tag ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read
Get tag group
Retrieve the tag group with the given tag group ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read
Get tag group relationships tags
Returns the tag IDs of all tags inside the given tag group.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read
Get tag groups
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.
Get tag group tags
Return the tags for a given tag group ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read
Get Tag Relationships
Tool to retrieve relationship IDs for a tag. Returns the IDs of related resources (campaigns, flows, lists, segments, or tag-group) associated with a specific tag. The response format varies based on the related_resource type: - For collections (campaigns, flows, lists, segments): returns an array of resource identifiers - For tag-group: returns a single resource identifier object Rate limits: 3/s burst, 60/m steady. Required scopes: tags:read and scope for the related resource type.
Get tags
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.
Get tag tag group
Returns the tag group resource for a given tag ID.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: tags:read
Get template
Get a template with the given template ID.
Rate limits:
Burst: 10/s
Steady: 150/m Scopes: templates:read
Get templates
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.
Get update categories jobs
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
Get update items job
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
Get update items jobs
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
Get update variants jobs
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
Get Variant IDs for Catalog Item
Tool to get all variant IDs related to a given catalog item ID. Returns a maximum of 100 variants per request. Use when you need to retrieve variant IDs without fetching full variant data. Supports filtering and sorting by creation date.
Get version ids for form
Get the IDs of the form versions for the given form.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read
Get versions for form
Get the form versions for the given form.
Rate limits:
Burst: 3/s
Steady: 60/m Scopes: forms:read
Get webhook
Get the webhook with the given ID.
Rate limits:
Burst: 1/s
Steady: 15/m Scopes: webhooks:read
Get webhooks
Get all webhooks in an account.
Rate limits:
Burst: 1/s
Steady: 15/m Scopes: webhooks:read
Get webhook topic
Retrieve details of a specific webhook topic by its ID. Webhook topics define the events that can trigger webhooks (e.g., email_delivered, sent_sms). Use this to get the human-readable name and metadata for a specific topic. Rate limits: Burst 1/s, Steady 15/m. Required scope: webhooks:read
Get webhook topics
Get all webhook topics in a Klaviyo account.
Rate limits:
Burst: 1/s
Steady: 15/m Scopes: webhooks:read
Merge profiles
Merge one or more source profiles into a destination profile. The source profile(s) data (events, attributes, list memberships) will be transferred to the destination, and the source profile(s) will be deleted. This operation is queued asynchronously and returns HTTP 202 Accepted. Rate limits: 10/s burst, 150/m steady. Requires profiles:write scope.
Query campaign values
Returns the requested campaign analytics values data
Rate limits:
Burst: 1/s
Steady: 2/m
Daily: 225/d Scopes: campaigns:read
Query flow series
Returns time-series analytics data for flows, enabling performance tracking over time intervals. Use this to analyze flow metrics like open rates, click rates, conversions, and delivery statistics. Rate limits: Burst 1/s, Steady 2/m, Daily 225/d. Scopes: flows:read
Query flow values
Returns the requested flow analytics values data
Rate limits:
Burst: 1/s
Steady: 2/m
Daily: 225/d Scopes: flows:read
Query metric aggregates
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'.
Remove Profile from List
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
Request profile deletion
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.
Spawn bulk profile import job
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.
Spawn coupon code bulk create job
Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max 1000 coupon codes per job. Max 100 jobs queued at once. Rate limits: Burst 75/s, Steady 700/m. Scopes: coupon-codes:write. Returns a job ID that can be used to query the job status via the get_coupon_code_bulk_create_job endpoint.
Spawn create categories job
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.
Spawn create items job
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.
Spawn create variants job
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.
Spawn delete categories job
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.
Spawn delete items job
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.
Spawn delete variants job
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.
Spawn update categories job
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.
Spawn update items job
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.
Spawn update variants job
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.
Subscribe profiles
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.
Suppress profiles
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.
Unregister client push token
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.
Unsubscribe profiles
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.
Unsubscribe Profiles Bulk
Tool to unsubscribe one or more profiles from a Klaviyo list. Use when you need to bulk unsubscribe up to 100 profiles from email or SMS marketing for a specific list.
Unsuppress profiles
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'.
Unsuppress Profiles (Bulk)
Tool to unsuppress one or more profiles from email marketing by email address. Use when you need to remove USER_SUPPRESSED status from profiles. This only removes suppressions with reason USER_SUPPRESSED; profiles with HARD_BOUNCE or INVALID_EMAIL suppressions remain unchanged. Returns a job object that can be monitored for completion status.
Update Campaign
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
Update campaign message
Update a campaign message
Rate limits:
Burst: 10/s
Steady: 150/m Scopes: campaigns:write
Update catalog category
Update a catalog category with the given category ID.
Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write
Update Catalog Category Relationships
Tool to update item relationships for a catalog category. Replaces all existing item relationships with the provided list. Use when you need to associate catalog items with a category or remove existing associations. Pass an empty data array to remove all item relationships from the category. Rate limits: 75/s burst, 700/m steady. Required scope: catalogs:write.
Update catalog category relationships items
Update item relationships for the given category ID.
Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write
Update catalog item
Update a catalog item with the given item ID.
Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write
Update catalog item relationships categories
Update catalog category relationships for the given item ID.
Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write
Update catalog variant
Update a catalog item variant with the given variant ID.
Rate limits:
Burst: 75/s
Steady: 700/m Scopes: catalogs:write
Update coupon
Update an existing coupon's properties. Currently, only the coupon description can be updated. The coupon ID (external_id) cannot be changed after creation. Rate limits:
Burst: 3/s
Steady: 60/m Scopes: coupons:write
Update coupon code
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
Update flow status
Update the status of a flow with the given flow ID, and all actions in that flow. Flow statuses: - 'draft': Flow is disabled; no messages will be sent - 'manual': Messages require manual approval before sending - 'live': Messages are sent automatically when triggered Rate limits: Burst: 3/s, Steady: 60/m Required scope: flows:write
Update image
Update the image with the given image ID.
Rate limits:
Burst: 10/s
Steady: 150/m Scopes: images:write
Update list
Update the name of a list with the given list ID.
Rate limits:
Burst: 10/s
Steady: 150/m Scopes: lists:write
Update profile
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.
Update segment
Update a segment with the given segment ID.
Rate limits:
Burst: 1/s
Steady: 15/m
Daily: 100/d Scopes: segments:write
Update tag
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. Important: The data__id in the request body must match the id path parameter. Returns HTTP 204 No Content on success. Rate limits: Burst: 3/s | Steady: 60/m Scopes: tags:read tags:write
Update tag group
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
Update template
Update an existing email template by ID. Supports updating name, HTML content, and plaintext content. Note: This action only works with CODE editor type templates; drag & drop templates cannot be updated via API. Rate limits: Burst 10/s, Steady 150/m. Requires 'templates:write' scope.
Update webhook
Update the webhook with the given ID.
Rate limits:
Burst: 1/s
Steady: 15/m Scopes: webhooks:write
Upload image from file
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
Upload image from url
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
Get started with Agent Jam and connect Klaviyo along with 700+ other apps to supercharge your workflow.