pp-klaviyo
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseKlaviyo — Printing Press CLI
Klaviyo — Printing Press CLI
Prerequisites: Install the CLI
前置条件:安装CLI
This skill drives the binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:
klaviyo-pp-cli- Install via the Printing Press installer:
bash
npx -y @mvanhorn/printing-press install klaviyo --cli-only - Verify:
klaviyo-pp-cli --version - Ensure (or
$GOPATH/bin) is on$HOME/go/bin.$PATH
If the install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.23+):
npxbash
go install github.com/mvanhorn/printing-press-library/library/marketing/klaviyo/cmd/klaviyo-pp-cli@latestIf reports "command not found" after install, the install step did not put the binary on . Do not proceed with skill commands until verification succeeds.
--version$PATH本技能基于二进制文件运行。在调用本技能的任何命令前,你必须确认CLI已安装。 如果未安装,请先执行以下步骤:
klaviyo-pp-cli- 通过Printing Press安装器安装:
bash
npx -y @mvanhorn/printing-press install klaviyo --cli-only - 验证安装:
klaviyo-pp-cli --version - 确保(或
$GOPATH/bin)已添加到$HOME/go/bin环境变量中。$PATH
如果安装失败(如无Node环境、离线等),可改用Go直接安装(要求Go 1.23及以上版本):
npxbash
go install github.com/mvanhorn/printing-press-library/library/marketing/klaviyo/cmd/klaviyo-pp-cli@latest如果安装后执行提示“command not found”,说明安装未将二进制文件添加到中。请在验证成功前不要执行技能命令。
--version$PATHWhen to Use This CLI
何时使用该CLI
Use this CLI when an agent needs to inspect or operate Klaviyo without the web UI, especially for profiles, events, campaigns, flows, segments, templates, metrics, and compound growth workflows.
当需要无需Web界面即可查看或操作Klaviyo时,可使用此CLI,尤其适用于用户档案、事件、营销活动、自动化流程、用户细分、模板、指标及复合增长工作流相关操作。
Unique Capabilities
独特功能
These capabilities aren't available in any other tool for this API.
这些功能是其他Klaviyo API工具所不具备的。
Campaign operations
营销活动操作
-
— Create an email template, create a draft campaign, and assign the template to the campaign message in one audited workflow.
campaigns deployAgents can build a draft campaign without hand-stitching three endpoint calls.bashklaviyo-pp-cli campaigns deploy --template-html ./email.html --campaign-name "May offer" --list-id LIST_ID --subject "May offer" --from-email marketing@example.com --from-label "Marketing" --json -
— Find a campaign message template and replace an image URL inside the HTML while preserving the rest of the draft.
campaigns image-swapAgents can make safe creative swaps without rebuilding a whole campaign.bashklaviyo-pp-cli campaigns image-swap --campaign-id CAMPAIGN_ID --old-url https://cdn.example.com/old.jpg --new-url https://cdn.example.com/new.jpg --json
-
— 在一个可审计的工作流中完成创建邮件模板、创建营销活动草稿、将模板分配给营销活动消息的全部操作。
campaigns deploy无需手动拼接三次接口调用,即可创建营销活动草稿。bashklaviyo-pp-cli campaigns deploy --template-html ./email.html --campaign-name "May offer" --list-id LIST_ID --subject "May offer" --from-email marketing@example.com --from-label "Marketing" --json -
— 查找营销活动消息模板,替换其中的图片URL,同时保留草稿的其他内容。
campaigns image-swap无需重建整个营销活动,即可安全替换创意素材。bashklaviyo-pp-cli campaigns image-swap --campaign-id CAMPAIGN_ID --old-url https://cdn.example.com/old.jpg --new-url https://cdn.example.com/new.jpg --json
Behavior graph analytics
行为图谱分析
-
— Identify flows whose open or click performance has decayed across recent time buckets using synced local data.
flow-decayAgents can spot lifecycle automations that need refresh before revenue falls further.bashklaviyo-pp-cli flow-decay --days 90 --threshold 0.15 --json -
— Group profiles by first event date and compute retention or repeat-action curves from synced profiles and events.
cohortAgents can answer which acquisition cohorts keep buying without exporting CSVs.bashklaviyo-pp-cli cohort --metric "Placed Order" --interval month --json --select cohort,profiles,retained -
— Join order events with campaign and flow attribution properties to summarize revenue by channel and source.
attributionAgents can explain which automation or campaign generated revenue using local event evidence.bashklaviyo-pp-cli attribution --metric "Placed Order" --group-by flow --since 2026-01-01 --json
-
— 使用同步的本地数据,识别近期时间区间内打开率或点击率下降的自动化流程。
flow-decay可在收益进一步下滑前发现需要优化的生命周期自动化流程。bashklaviyo-pp-cli flow-decay --days 90 --threshold 0.15 --json -
— 按首次事件日期对用户档案分组,并根据同步的用户档案和事件计算留存率或重复行为曲线。
cohort无需导出CSV即可分析哪些获客群组持续产生购买行为。bashklaviyo-pp-cli cohort --metric "Placed Order" --interval month --json --select cohort,profiles,retained -
— 将订单事件与营销活动和自动化流程的归因属性关联,按渠道和来源汇总收益。
attribution可通过本地事件数据说明哪些自动化流程或营销活动产生了收益。bashklaviyo-pp-cli attribution --metric "Placed Order" --group-by flow --since 2026-01-01 --json
Data hygiene
数据清洁
-
— Find profiles that appear duplicated by email, phone, or cross-channel collisions in the local profile mirror.
dedupAgents can flag customer records that split behavior and revenue history across identities.bashklaviyo-pp-cli dedup --by email,phone --json -
— Compare campaign UTM evidence with local Klaviyo order events and optional Shopify credentials when available.
reconcileAgents can check whether campaign performance agrees with order evidence before reporting numbers.bashklaviyo-pp-cli reconcile --campaign-id CAMPAIGN_ID --since 2026-01-01 --json
-
— 在本地用户档案镜像中查找因邮箱、电话或跨渠道冲突导致的重复用户档案。
dedup可标记那些在不同身份下拆分行为和收益历史的客户记录。bashklaviyo-pp-cli dedup --by email,phone --json -
— 对比营销活动UTM数据与本地Klaviyo订单事件,若有Shopify凭证也可一并使用。
reconcile在上报数据前,可检查营销活动表现与订单数据是否一致。bashklaviyo-pp-cli reconcile --campaign-id CAMPAIGN_ID --since 2026-01-01 --json
Growth planning
增长规划
-
— Turn a growth brief into a structured Klaviyo campaign, flow, segment, and experiment strategy.
plan brief-to-strategyAgents can convert strategy notes into a concrete Klaviyo execution plan.bashklaviyo-pp-cli plan brief-to-strategy --brief ./brief.md --json -
— Run a launch-readiness checklist for links, offers, dates, timezone, fallback tokens, compliance, and deliverability flags.
plan qa-gateAgents can block risky campaign launches with explicit findings instead of vague review notes.bashklaviyo-pp-cli plan qa-gate --campaign-id CAMPAIGN_ID --json
-
— 将增长简报转化为结构化的Klaviyo营销活动、自动化流程、用户细分及实验策略。
plan brief-to-strategy可将战略笔记转化为具体的Klaviyo执行计划。bashklaviyo-pp-cli plan brief-to-strategy --brief ./brief.md --json -
— 针对链接、优惠、日期、时区、回退令牌、合规性及送达性标志运行启动就绪检查清单。
plan qa-gate可通过明确的检查结果阻止高风险营销活动上线,而非模糊的审核备注。bashklaviyo-pp-cli plan qa-gate --campaign-id CAMPAIGN_ID --json
Command Reference
命令参考
accounts — accounts
- — Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array....
klaviyo-pp-cli accounts get - — Retrieve a single account object by its account ID. You can only request the account by which the private API key...
klaviyo-pp-cli accounts get-id
back-in-stock-subscriptions — Manage back in stock subscriptions
- — Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API...
klaviyo-pp-cli back-in-stock-subscriptions
campaign-clone — Manage campaign clone
- — Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate...
klaviyo-pp-cli campaign-clone
campaign-message-assign-template — Manage campaign message assign template
- — Creates a non-reusable version of the template and assigns it to the message.<br><br>Rate limits:<br>Burst:...
klaviyo-pp-cli campaign-message-assign-template
campaign-messages — Manage campaign messages
- — Returns a specific message based on a required id.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli campaign-messages get<br>Steady:10/s...150/m - — Update a campaign message<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli campaign-messages update<br>Steady:10/sScopes:150/mcampaigns:write
campaign-recipient-estimation-jobs — Manage campaign recipient estimation jobs
- — Retrieve the status of a recipient estimation job triggered with the
klaviyo-pp-cli campaign-recipient-estimation-jobs get...Create Campaign Recipient Estimation Job - — Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get...
klaviyo-pp-cli campaign-recipient-estimation-jobs refresh-campaign-recipient-estimation
campaign-recipient-estimations — Manage campaign recipient estimations
- — Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using...
klaviyo-pp-cli campaign-recipient-estimations <id>
campaign-send-jobs — Manage campaign send jobs
- — Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to...
klaviyo-pp-cli campaign-send-jobs cancel-campaign-send - — Get a campaign send job<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli campaign-send-jobs get<br>Steady:10/sScopes:150/mcampaigns:read - — Trigger a campaign to send asynchronously<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli campaign-send-jobs send-campaign<br>Steady:10/sScopes:...150/m
campaign-values-reports — Manage campaign values reports
- — Returns the requested campaign analytics values data<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli campaign-values-reports<br>Steady:...1/s
campaigns — campaigns
- — Creates a campaign given a set of parameters, then returns it.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli campaigns create<br>Steady:...10/s - — Delete a campaign with the given campaign ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli campaigns delete<br>Steady:10/sScopes:...150/m - — Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide...
klaviyo-pp-cli campaigns get - — Returns a specific campaign based on a required id.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli campaigns get-id<br>Steady:10/s...150/m - — Update a campaign with the given campaign ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli campaigns update<br>Steady:10/sScopes:...150/m
catalog-categories — Manage catalog categories
- — Create a new catalog category.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-categories create-catalog-category<br>Steady:75/sScopes:750/mcatalogs:write - — Delete a catalog category using the given category ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-categories delete-catalog-category<br>Steady:75/s...750/m - — Get all catalog categories in an account. Catalog categories can be sorted by the following fields, in ascending and...
klaviyo-pp-cli catalog-categories get - — Get a catalog category with the given category ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-categories get-catalog-category<br>Steady:350/s...3500/m - — Update a catalog category with the given category ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-categories update-catalog-category<br>Steady:75/s...750/m
catalog-category-bulk-create-jobs — Manage catalog category bulk create jobs
- — Create a catalog category bulk create job to create a batch of catalog categories. Accepts up to 100 catalog...
klaviyo-pp-cli catalog-category-bulk-create-jobs bulk-create-catalog-categories - — Get a catalog category bulk create job with the given job ID. An
klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-jobparameter can be provided to get the...include - — Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate...
klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-jobs
catalog-category-bulk-delete-jobs — Manage catalog category bulk delete jobs
- — Create a catalog category bulk delete job to delete a batch of catalog categories. Accepts up to 100 catalog...
klaviyo-pp-cli catalog-category-bulk-delete-jobs bulk-delete-catalog-categories - — Get a catalog category bulk delete job with the given job ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-job<br>Steady:...350/s - — Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate...
klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-jobs
catalog-category-bulk-update-jobs — Manage catalog category bulk update jobs
- — Create a catalog category bulk update job to update a batch of catalog categories. Accepts up to 100 catalog...
klaviyo-pp-cli catalog-category-bulk-update-jobs bulk-update-catalog-categories - — Get a catalog category bulk update job with the given job ID. An
klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-jobparameter can be provided to get the...include - — Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate...
klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-jobs
catalog-item-bulk-create-jobs — Manage catalog item bulk create jobs
- — Create a catalog item bulk create job to create a batch of catalog items. Accepts up to 100 catalog items per...
klaviyo-pp-cli catalog-item-bulk-create-jobs bulk-create-catalog-items - — Get a catalog item bulk create job with the given job ID. An
klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-jobparameter can be provided to get the...include - — Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-jobs
catalog-item-bulk-delete-jobs — Manage catalog item bulk delete jobs
- — Create a catalog item bulk delete job to delete a batch of catalog items. Accepts up to 100 catalog items per...
klaviyo-pp-cli catalog-item-bulk-delete-jobs bulk-delete-catalog-items - — Get a catalog item bulk delete job with the given job ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-job<br>Steady:...350/s - — Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-jobs
catalog-item-bulk-update-jobs — Manage catalog item bulk update jobs
- — Create a catalog item bulk update job to update a batch of catalog items. Accepts up to 100 catalog items per...
klaviyo-pp-cli catalog-item-bulk-update-jobs bulk-update-catalog-items - — Get a catalog item bulk update job with the given job ID. An
klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-jobparameter can be provided to get the...include - — Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-jobs
catalog-items — Manage catalog items
- — Create a new catalog item.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-items create<br>Steady:75/sScopes:750/mcatalogs:write - — Delete a catalog item with the given item ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-items delete<br>Steady:75/sScopes:...750/m - — Get all catalog items in an account. Catalog items can be sorted by the following fields, in ascending and...
klaviyo-pp-cli catalog-items get - — Get a specific catalog item with the given item ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-items get-catalogitems<br>Steady:350/s...3500/m - — Update a catalog item with the given item ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-items update<br>Steady:75/sScopes:...750/m
catalog-variant-bulk-create-jobs — Manage catalog variant bulk create jobs
- — Create a catalog variant bulk create job to create a batch of catalog variants. Accepts up to 100 catalog variants...
klaviyo-pp-cli catalog-variant-bulk-create-jobs bulk-create-catalog-variants - — Get a catalog variant bulk create job with the given job ID. An
klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-jobparameter can be provided to get the...include - — Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-jobs
catalog-variant-bulk-delete-jobs — Manage catalog variant bulk delete jobs
- — Create a catalog variant bulk delete job to delete a batch of catalog variants. Accepts up to 100 catalog variants...
klaviyo-pp-cli catalog-variant-bulk-delete-jobs bulk-delete-catalog-variants - — Get a catalog variant bulk delete job with the given job ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-job<br>Steady:...350/s - — Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-jobs
catalog-variant-bulk-update-jobs — Manage catalog variant bulk update jobs
- — Create a catalog variant bulk update job to update a batch of catalog variants. Accepts up to 100 catalog variants...
klaviyo-pp-cli catalog-variant-bulk-update-jobs bulk-update-catalog-variants - — Get a catalog variate bulk update job with the given job ID. An
klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-jobparameter can be provided to get the...include - — Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-jobs
catalog-variants — Manage catalog variants
- — Create a new variant for a related catalog item.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-variants create<br>Steady:75/s...750/m - — Delete a catalog item variant with the given variant ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-variants delete<br>Steady:75/s...750/m - — Get all variants in an account. Variants can be sorted by the following fields, in ascending and descending order:...
klaviyo-pp-cli catalog-variants get - — Get a catalog item variant with the given variant ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-variants get-catalogvariants<br>Steady:350/s...3500/m - — Update a catalog item variant with the given variant ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli catalog-variants update<br>Steady:75/s...750/m
client — client
- — Create new events to track a profile's activity. This endpoint is specifically designed to be called from...
klaviyo-pp-cli client bulk-create-events - — Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API...
klaviyo-pp-cli client create-back-in-stock-subscription - — Create a new event to track a profile's activity. This endpoint is specifically designed to be called from...
klaviyo-pp-cli client create-event - — Create or update properties about a profile without tracking an associated event. This endpoint is specifically...
klaviyo-pp-cli client create-profile - — Create or update a push token. This endpoint is specifically designed to be called from our mobile SDKs...
klaviyo-pp-cli client create-push-token - — Create a review with the given ID. This endpoint is for client-side environments only.<br><br>*Rate...
klaviyo-pp-cli client create-review - — Creates a subscription and consent record for email and/or SMS channels based on the provided
klaviyo-pp-cli client create-subscriptionand...email - — Get all geofences in an account. Returns a paginated list of all geofences for the specified company. This is the GA...
klaviyo-pp-cli client get-geofences - — Get all reviews values reports in an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli client get-review-values-reports<br>Steady:10/s150/m - — Get all reviews. This endpoint is for client-side environments only, for server-side use, refer to...
klaviyo-pp-cli client get-reviews - — Unregister a push token. This endpoint is specifically designed to be called from our mobile SDKs...
klaviyo-pp-cli client unregister-push-token
conversation-messages — Manage conversation messages
- — Send an outbound message to a conversation. Requires OAuth authentication and account-level enablement. To request...
klaviyo-pp-cli conversation-messages
coupon-code-bulk-create-jobs — Manage coupon code bulk create jobs
- — Create a coupon-code-bulk-create-job to bulk create a list of coupon codes. Max number of coupon codes per job we...
klaviyo-pp-cli coupon-code-bulk-create-jobs bulk-create-coupon-codes - — Get all coupon code bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
klaviyo-pp-cli coupon-code-bulk-create-jobs get-bulk-create-coupon-code-jobs - — Get a coupon code bulk create job with the given job ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli coupon-code-bulk-create-jobs get-bulk-create-coupon-codes-job<br>Steady:75/s...750/m
coupon-codes — Manage coupon codes
- — Synchronously creates a coupon code for the given coupon.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli coupon-codes create<br>Steady:...350/s - — Deletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the coupon...
klaviyo-pp-cli coupon-codes delete - — Gets a list of coupon codes associated with a coupon/coupons or a profile/profiles. A coupon/coupons or a...
klaviyo-pp-cli coupon-codes get - — Returns a Coupon Code specified by the given identifier.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli coupon-codes get-couponcodes<br>Steady:350/s...3500/m - — Updates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and...
klaviyo-pp-cli coupon-codes update
coupons — coupons
- — Creates a new coupon.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli coupons create<br>Steady:3/sScopes:60/mcoupons:write - — Delete the coupon with the given coupon ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli coupons delete<br>Steady:3/sScopes:...60/m - — Get all coupons in an account. To learn more, see our [Coupons API...
klaviyo-pp-cli coupons get - — Get a specific coupon with the given coupon ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli coupons get-id<br>Steady:75/s...750/m - — Rate limits:<br>Burst:
klaviyo-pp-cli coupons update<br>Steady:3/sScopes:60/mcoupons:write
custom-metrics — Manage custom metrics
- — Create a new custom metric. Custom metric objects must include a
klaviyo-pp-cli custom-metrics createandname.<br><br>*Rate...definition - — Delete a custom metric with the given custom metric ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli custom-metrics delete<br>Steady:3/s...60/m - — Get all custom metrics in an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli custom-metrics get<br>Steady:3/sScopes:60/mmetrics:read - — Get a custom metric with the given custom metric ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli custom-metrics get-custommetrics<br>Steady:3/s...60/m - — Update a custom metric with the given custom metric ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli custom-metrics update<br>Steady:...1/s
data-privacy-deletion-jobs — Manage data privacy deletion jobs
- — Request a deletion for the profiles corresponding to one of the following identifiers:
klaviyo-pp-cli data-privacy-deletion-jobs,email, or...phone_number
data-source-record-bulk-create-jobs — Manage data source record bulk create jobs
- — Create a bulk data source record import job to create a batch of records. Accepts up to 500 records per request. The...
klaviyo-pp-cli data-source-record-bulk-create-jobs
data-source-record-create-jobs — Manage data source record create jobs
- — Create a data source record import job to create a single record. The maximum allowed payload size per-record is...
klaviyo-pp-cli data-source-record-create-jobs
data-sources — Manage data sources
- — Create a new data source in an account<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli data-sources create<br>Steady:3/sScopes:...60/m - — Delete a data source in an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli data-sources delete<br>Steady:3/sScopes:...60/m - — Get all data sources in an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli data-sources get<br>Steady:3/sScopes:...60/m - — Retrieve a data source in an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli data-sources get-datasources<br>Steady:3/sScopes:...60/m
event-bulk-create-jobs — Manage event bulk create jobs
- — Create a batch of events for one or more profiles. Note that this endpoint allows you to create new profiles or...
klaviyo-pp-cli event-bulk-create-jobs
events — events
- — Create a new event to track a profile's activity. Note that this endpoint allows you to create a new profile or...
klaviyo-pp-cli events create - — Get all events in an account Requests can be sorted by the following fields:
klaviyo-pp-cli events get,datetime[Custom...timestamp - — Get an event with the given event ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli events get-id<br>Steady:10/sScopes:...150/m
flow-actions — Manage flow actions
- — Get a flow action from a flow with the given flow action ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli flow-actions get<br>Steady:3/s...60/m - — Update a flow action.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli flow-actions update<br>Steady:3/sScopes:60/mflows:write
flow-messages — Manage flow messages
- — Get a flow message from a flow with the given flow message ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli flow-messages <id><br>Steady:...3/s
flow-series-reports — Manage flow series reports
- — Returns the requested flow analytics series data<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli flow-series-reports<br>Steady:1/s<br>Daily:...2/m
flow-values-reports — Manage flow values reports
- — Returns the requested flow analytics values data<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli flow-values-reports<br>Steady:1/s<br>Daily:...2/m
flows — flows
- — Create a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will...
klaviyo-pp-cli flows create - — Delete a flow with the given flow ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli flows delete<br>Steady:3/sScopes:60/mflows:write - — Get all flows in an account. Returns a maximum of 50 flows per request, which can be paginated with cursor-based...
klaviyo-pp-cli flows get - — Get a flow with the given flow ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli flows get-id<br>Steady:3/sScopes:60/mflows:read - — Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>Rate limits:<br>Burst:...
klaviyo-pp-cli flows update
form-series-reports — Manage form series reports
- — Returns the requested form analytics series data.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli form-series-reports<br>Steady:1/s<br>Daily:...2/m
form-values-reports — Manage form values reports
- — Returns the requested form analytics values data.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli form-values-reports<br>Steady:1/s<br>Daily:...2/m
form-versions — Manage form versions
- — Get the form version with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli form-versions <id><br>Steady:3/sScopes:60/mforms:read
forms — forms
- — Create a new form.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli forms create<br>Steady:3/sScopes:60/mforms:write - — Delete a given form.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli forms delete<br>Steady:3/sScopes:60/mforms:write - — Get all forms in an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli forms get<br>Steady:3/sScopes:60/mforms:read - — Get the form with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli forms get-id<br>Steady:3/sScopes:60/mforms:read
image-upload — Manage image upload
- — 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...
klaviyo-pp-cli image-upload
images — images
- — Get all images in an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli images get<br>Steady:10/sScopes:150/mimages:read - — Get the image with the given image ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli images get-id<br>Steady:10/sScopes:...150/m - — Update the image with the given image ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli images update<br>Steady:10/sScopes:...150/m - — 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...
klaviyo-pp-cli images upload-from-url
lists — lists
- — Create a new list.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli lists create<br>Steady:10/s<br>Daily:150/mScopes:150/dlists:write - — Delete a list with the given list ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli lists delete<br>Steady:10/sScopes:...150/m - — Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by
klaviyo-pp-cli lists get,id,...name - — Get a list with the given list ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli lists get-id<br>Steady:75/s<br><br>Rate limits when...750/m - — Update the name of a list with the given list ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli lists update<br>Steady:10/s...150/m
mapped-metrics — Manage mapped metrics
- — Get all mapped metrics in an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli mapped-metrics get<br>Steady:3/sScopes:60/mmetrics:read - — Get the mapped metric with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli mapped-metrics get-mappedmetrics<br>Steady:3/sScopes:...60/m - — Update the mapped metric with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli mapped-metrics update<br>Steady:1/s<br>Daily:15/m...30/d
metric-aggregates — Manage metric aggregates
- — Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific...
klaviyo-pp-cli metric-aggregates
metric-properties — Manage metric properties
- — Get a metric property with the given metric property ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli metric-properties <id><br>Steady:1/s...15/m
metrics — metrics
- — Get all metrics in an account. Requests can be filtered by the following fields: integration
klaviyo-pp-cli metrics get, integration...name - — Get a metric with the given metric ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli metrics get-id<br>Steady:10/sScopes:...150/m
profile-bulk-import-jobs — Manage profile bulk import jobs
- — Create a bulk profile import job to create or update a batch of profiles. Accepts up to 10,000 profiles per request....
klaviyo-pp-cli profile-bulk-import-jobs bulk-import-profiles - — Get a bulk profile import job with the given job ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-job<br>Steady:10/s...150/m - — Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-jobs
profile-import — Manage profile import
- — Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was...
klaviyo-pp-cli profile-import
profile-merge — Manage profile merge
- — Merge a given related profile into a profile with the given profile ID. The profile provided under
klaviyo-pp-cli profile-merge...relationships
profile-subscription-bulk-create-jobs — Manage profile subscription bulk create jobs
- — Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double...
klaviyo-pp-cli profile-subscription-bulk-create-jobs
profile-subscription-bulk-delete-jobs — Manage profile subscription bulk delete jobs
- — > 🚧 > > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership...
klaviyo-pp-cli profile-subscription-bulk-delete-jobs
profile-suppression-bulk-create-jobs — Manage profile suppression bulk create jobs
- — Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a...
klaviyo-pp-cli profile-suppression-bulk-create-jobs bulk-suppress-profiles - — Get the bulk suppress profiles job with the given job ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-job<br>Steady:75/s...750/m - — Get the status of all bulk profile suppression jobs.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-jobs<br>Steady:75/s...750/m
profile-suppression-bulk-delete-jobs — Manage profile suppression bulk delete jobs
- — Manually unsuppress profiles by email address or specify a segment/list ID to unsuppress all current members of a...
klaviyo-pp-cli profile-suppression-bulk-delete-jobs bulk-unsuppress-profiles - — Get the bulk unsuppress profiles job with the given job ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-job<br>Steady:...75/s - — Get all bulk unsuppress profiles jobs.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-jobs<br>Steady:75/sScopes:...750/m
profiles — profiles
- — Create a new profile. Use the
klaviyo-pp-cli profiles createparameter to include subscriptions and predictive analytics data...additional-fields - — Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order:...
klaviyo-pp-cli profiles get - — Get the profile with the given profile ID. Use the
klaviyo-pp-cli profiles get-idparameter to include subscriptions and...additional-fields - — Update the profile with the given profile ID. Use the
klaviyo-pp-cli profiles updateparameter to include subscriptions and...additional-fields
push-tokens — Manage push tokens
- — Create or update a push token. This endpoint can be used to migrate push tokens from another platform to Klaviyo....
klaviyo-pp-cli push-tokens create - — Delete a specific push token based on its ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli push-tokens delete<br>Steady:3/sScopes:...60/m - — Return push tokens associated with company.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli push-tokens get<br>Steady:10/sScopes:...150/m - — Return a specific push token based on its ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli push-tokens get-pushtokens<br>Steady:10/sScopes:...150/m
reviews — reviews
- — Get all reviews.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli reviews get<br>Steady:10/sScopes:150/mreviews:read - — Get the review with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli reviews get-id<br>Steady:10/sScopes:150/mreviews:read - — Update a review.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli reviews update<br>Steady:10/sScopes:150/mreviews:write
segment-series-reports — Manage segment series reports
- — Returns the requested segment analytics series data.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli segment-series-reports<br>Steady:...1/s
segment-values-reports — Manage segment values reports
- — Returns the requested segment analytics values data.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli segment-values-reports<br>Steady:...1/s
segments — segments
- — Create a segment.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli segments create<br>Steady:1/s<br>Daily:15/mScopes:100/dsegments:write - — Delete a segment with the given segment ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli segments delete<br>Steady:3/sScopes:...60/m - — Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by
klaviyo-pp-cli segments get,...name - — Get a segment with the given segment ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli segments get-id<br>Steady:75/s<br><br>Rate...750/m - — Update a segment with the given segment ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli segments update<br>Steady:1/s<br>Daily:...15/m
tag-groups — Manage tag groups
- — Create a tag group. An account cannot have more than 50 unique tag groups. If
klaviyo-pp-cli tag-groups createis not specified...exclusive - — Delete the tag group with the given tag group ID. Any tags inside that tag group, and any associations between those...
klaviyo-pp-cli tag-groups delete - — List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by
klaviyo-pp-cli tag-groups get,...name - — Retrieve the tag group with the given tag group ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli tag-groups get-taggroups<br>Steady:3/s...60/m - — Update the tag group with the given tag group ID. Only a tag group's
klaviyo-pp-cli tag-groups updatecan be changed. A tag group's...name
tags — tags
- — Create a tag. An account cannot have more than 500 unique tags. A tag belongs to a single tag group. If...
klaviyo-pp-cli tags create - — Delete the tag with the given tag ID. Any associations between the tag and other resources will also be...
klaviyo-pp-cli tags delete - — List all tags in an account. Tags can be filtered by
klaviyo-pp-cli tags get, and sorted bynameornamein ascending or descending...id - — Retrieve the tag with the given tag ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli tags get-id<br>Steady:3/sScopes:60/mtags:read - — Update the tag with the given tag ID. Only a tag's
klaviyo-pp-cli tags updatecan be changed. A tag cannot be moved from one tag group...name
template-clone — Manage template clone
- — Create a clone of a template with the given template ID. If there are 1,000 or more templates in an account, cloning...
klaviyo-pp-cli template-clone
template-render — Manage template render
- — Render a template with the given template ID and context attribute. Returns the AMP, HTML, and plain text versions...
klaviyo-pp-cli template-render
template-universal-content — Manage template universal content
- — Create universal content. Currently supported block types are:
klaviyo-pp-cli template-universal-content create-universal-content,button,drop_shadow,horizontal_rule,...html - — Delete the universal content with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli template-universal-content delete-universal-content<br>Steady:75/s...750/m - — Get all universal content in an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli template-universal-content get-all-universal-content<br>Steady:75/sScopes:...750/m - — Get the universal content with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli template-universal-content get-universal-content<br>Steady:75/sScopes:...750/m - — Update universal content. The
klaviyo-pp-cli template-universal-content update-universal-contentfield can only be updated on the following block types at this time:...definition
templates — templates
- — Create a new HTML or drag-and-drop template. If there are 1,000 or more templates in an account, creation will fail...
klaviyo-pp-cli templates create - — Delete a template with the given template ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli templates delete<br>Steady:75/sScopes:...750/m - — Get all templates in an account. Use
klaviyo-pp-cli templates getto include the full template...additional-fields[template]=definition - — Get a template with the given template ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli templates get-id<br>Steady:75/sScopes:...750/m - — Update a template with the given template ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli templates update<br>Steady:75/sScopes:...750/m
tracking-settings — tracking settings
- — Get all UTM tracking settings in an account. Returns an array with a single tracking setting. More information about...
klaviyo-pp-cli tracking-settings get - — Get the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found...
klaviyo-pp-cli tracking-settings get-trackingsettings - — Update the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found...
klaviyo-pp-cli tracking-settings update
web-feeds — web feeds
- — Create a web feed.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli web-feeds create<br>Steady:1/sScopes:15/mweb-feeds:write - — Delete the web feed with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli web-feeds delete<br>Steady:1/sScopes:...15/m - — Get all web feeds for an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli web-feeds get<br>Steady:1/sScopes:15/mweb-feeds:read - — Get the web feed with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli web-feeds get-webfeeds<br>Steady:1/sScopes:15/mweb-feeds:read - — Update the web feed with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli web-feeds update<br>Steady:1/sScopes:...15/m
webhook-topics — Manage webhook topics
- — Get all webhook topics in a Klaviyo account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli webhook-topics get<br>Steady:1/sScopes:...15/m - — Get the webhook topic with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli webhook-topics get-webhooktopics<br>Steady:1/sScopes:...15/m
webhooks — webhooks
- — Create a new Webhook<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli webhooks create<br>Steady:1/sScopes:15/mwebhooks:write - — Delete a webhook with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli webhooks delete<br>Steady:1/sScopes:15/mwebhooks:write - — Get all webhooks in an account.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli webhooks get<br>Steady:1/sScopes:15/mwebhooks:read - — Get the webhook with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli webhooks get-id<br>Steady:1/sScopes:15/mwebhooks:read - — Update the webhook with the given ID.<br><br>Rate limits:<br>Burst:
klaviyo-pp-cli webhooks update<br>Steady:1/sScopes:...15/m
accounts — 账户管理
- — 获取与给定私有API密钥关联的账户。返回结果为包含1个账户对象的数组....
klaviyo-pp-cli accounts get - — 通过账户ID获取单个账户对象。仅可通过与私有API密钥关联的账户进行请求...
klaviyo-pp-cli accounts get-id
back-in-stock-subscriptions — 补货通知订阅管理
- — 订阅补货通知。详情请查看[我们的补货通知API...
klaviyo-pp-cli back-in-stock-subscriptions
campaign-clone — 营销活动克隆管理
- — 克隆现有营销活动,返回一个基于原活动的新活动,包含新的ID和名称。<br><br>*调用频率限制...
klaviyo-pp-cli campaign-clone
campaign-message-assign-template — 营销活动消息模板分配管理
- — 创建模板的不可复用版本,并将其分配给消息。<br><br>调用频率限制:<br>突发:...
klaviyo-pp-cli campaign-message-assign-template
campaign-messages — 营销活动消息管理
- — 根据必填ID返回特定消息。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli campaign-messages get<br>稳定:10/s...150/m - — 更新营销活动消息<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli campaign-messages update<br>稳定:10/s权限范围:150/mcampaigns:write
campaign-recipient-estimation-jobs — 营销活动收件人估算任务管理
- — 获取通过“创建营销活动收件人估算任务”触发的任务状态...
klaviyo-pp-cli campaign-recipient-estimation-jobs get - — 触发异步任务更新指定营销活动ID的预估收件人数。使用“获取...
klaviyo-pp-cli campaign-recipient-estimation-jobs refresh-campaign-recipient-estimation
campaign-recipient-estimations — 营销活动收件人估算管理
- — 根据提供的营销活动ID获取预估收件人数。可通过使用...刷新该数值
klaviyo-pp-cli campaign-recipient-estimations <id>
campaign-send-jobs — 营销活动发送任务管理
- — 永久取消营销活动,将状态设置为CANCELED,或撤销营销活动,将状态恢复为...
klaviyo-pp-cli campaign-send-jobs cancel-campaign-send - — 获取营销活动发送任务<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli campaign-send-jobs get<br>稳定:10/s权限范围:150/mcampaigns:read - — 触发营销活动异步发送<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli campaign-send-jobs send-campaign<br>稳定:10/s权限范围:...150/m
campaign-values-reports — 营销活动数值报告管理
- — 返回请求的营销活动分析数值数据<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli campaign-values-reports<br>稳定:...1/s
campaigns — 营销活动管理
- — 根据一组参数创建营销活动并返回该活动。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli campaigns create<br>稳定:...10/s - — 根据给定营销活动ID删除营销活动。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli campaigns delete<br>稳定:10/s权限范围:...150/m - — 根据筛选条件返回部分或全部营销活动。列出营销活动时必须提供渠道筛选条件。请提供...
klaviyo-pp-cli campaigns get - — 根据必填ID返回特定营销活动。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli campaigns get-id<br>稳定:10/s...150/m - — 根据给定营销活动ID更新营销活动。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli campaigns update<br>稳定:10/s权限范围:...150/m
catalog-categories — 商品分类管理
- — 创建新的商品分类。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-categories create-catalog-category<br>稳定:75/s权限范围:750/mcatalogs:write - — 根据给定分类ID删除商品分类。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-categories delete-catalog-category<br>稳定:75/s...750/m - — 获取账户内所有商品分类。商品分类可按以下字段进行升序或降序排序...
klaviyo-pp-cli catalog-categories get - — 根据给定分类ID获取商品分类。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-categories get-catalog-category<br>稳定:350/s...3500/m - — 根据给定分类ID更新商品分类。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-categories update-catalog-category<br>稳定:75/s...750/m
catalog-category-bulk-create-jobs — 商品分类批量创建任务管理
- — 创建商品分类批量创建任务,批量创建商品分类。每次请求最多支持100个商品...
klaviyo-pp-cli catalog-category-bulk-create-jobs bulk-create-catalog-categories - — 根据给定任务ID获取商品分类批量创建任务。可提供
klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-job参数获取...include - — 获取所有商品分类批量创建任务。每次请求最多返回100个任务。<br><br>*调用频率...
klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-jobs
catalog-category-bulk-delete-jobs — 商品分类批量删除任务管理
- — 创建商品分类批量删除任务,批量删除商品分类。每次请求最多支持100个商品...
klaviyo-pp-cli catalog-category-bulk-delete-jobs bulk-delete-catalog-categories - — 根据给定任务ID获取商品分类批量删除任务。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-job<br>稳定:...350/s - — 获取所有商品分类批量删除任务。每次请求最多返回100个任务。<br><br>*调用频率...
klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-jobs
catalog-category-bulk-update-jobs — 商品分类批量更新任务管理
- — 创建商品分类批量更新任务,批量更新商品分类。每次请求最多支持100个商品...
klaviyo-pp-cli catalog-category-bulk-update-jobs bulk-update-catalog-categories - — 根据给定任务ID获取商品分类批量更新任务。可提供
klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-job参数获取...include - — 获取所有商品分类批量更新任务。每次请求最多返回100个任务。<br><br>*调用频率...
klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-jobs
catalog-item-bulk-create-jobs — 商品项批量创建任务管理
- — 创建商品项批量创建任务,批量创建商品项。每次请求最多支持100个商品项...
klaviyo-pp-cli catalog-item-bulk-create-jobs bulk-create-catalog-items - — 根据给定任务ID获取商品项批量创建任务。可提供
klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-job参数获取...include - — 获取所有商品项批量创建任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-jobs
catalog-item-bulk-delete-jobs — 商品项批量删除任务管理
- — 创建商品项批量删除任务,批量删除商品项。每次请求最多支持100个商品项...
klaviyo-pp-cli catalog-item-bulk-delete-jobs bulk-delete-catalog-items - — 根据给定任务ID获取商品项批量删除任务。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-job<br>稳定:...350/s - — 获取所有商品项批量删除任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-jobs
catalog-item-bulk-update-jobs — 商品项批量更新任务管理
- — 创建商品项批量更新任务,批量更新商品项。每次请求最多支持100个商品项...
klaviyo-pp-cli catalog-item-bulk-update-jobs bulk-update-catalog-items - — 根据给定任务ID获取商品项批量更新任务。可提供
klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-job参数获取...include - — 获取所有商品项批量更新任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-jobs
catalog-items — 商品项管理
- — 创建新的商品项。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-items create<br>稳定:75/s权限范围:750/mcatalogs:write - — 根据给定商品项ID删除商品项。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-items delete<br>稳定:75/s权限范围:...750/m - — 获取账户内所有商品项。商品项可按以下字段进行升序或降序排序...
klaviyo-pp-cli catalog-items get - — 根据给定商品项ID获取特定商品项。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-items get-catalogitems<br>稳定:350/s...3500/m - — 根据给定商品项ID更新商品项。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-items update<br>稳定:75/s权限范围:...750/m
catalog-variant-bulk-create-jobs — 商品变体批量创建任务管理
- — 创建商品变体批量创建任务,批量创建商品变体。每次请求最多支持100个商品变体...
klaviyo-pp-cli catalog-variant-bulk-create-jobs bulk-create-catalog-variants - — 根据给定任务ID获取商品变体批量创建任务。可提供
klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-job参数获取...include - — 获取所有商品变体批量创建任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-jobs
catalog-variant-bulk-delete-jobs — 商品变体批量删除任务管理
- — 创建商品变体批量删除任务,批量删除商品变体。每次请求最多支持100个商品变体...
klaviyo-pp-cli catalog-variant-bulk-delete-jobs bulk-delete-catalog-variants - — 根据给定任务ID获取商品变体批量删除任务。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-job<br>稳定:...350/s - — 获取所有商品变体批量删除任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-jobs
catalog-variant-bulk-update-jobs — 商品变体批量更新任务管理
- — 创建商品变体批量更新任务,批量更新商品变体。每次请求最多支持100个商品变体...
klaviyo-pp-cli catalog-variant-bulk-update-jobs bulk-update-catalog-variants - — 根据给定任务ID获取商品变体批量更新任务。可提供
klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-job参数获取...include - — 获取所有商品变体批量更新任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-jobs
catalog-variants — 商品变体管理
- — 为关联商品项创建新变体。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-variants create<br>稳定:75/s...750/m - — 根据给定变体ID删除商品项变体。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-variants delete<br>稳定:75/s...750/m - — 获取账户内所有变体。变体可按以下字段进行升序或降序排序...
klaviyo-pp-cli catalog-variants get - — 根据给定变体ID获取商品项变体。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-variants get-catalogvariants<br>稳定:350/s...3500/m - — 根据给定变体ID更新商品项变体。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli catalog-variants update<br>稳定:75/s...750/m
client — 客户端操作
- — 创建新事件以追踪用户档案的活动。该接口专门设计用于从...调用
klaviyo-pp-cli client bulk-create-events - — 订阅补货通知。详情请查看[我们的补货通知API...
klaviyo-pp-cli client create-back-in-stock-subscription - — 创建新事件以追踪用户档案的活动。该接口专门设计用于从...调用
klaviyo-pp-cli client create-event - — 创建或更新用户档案属性,无需关联追踪事件。该接口专门...
klaviyo-pp-cli client create-profile - — 创建或更新推送令牌。该接口专门设计用于从我们的移动SDK调用...
klaviyo-pp-cli client create-push-token - — 根据给定ID创建评论。该接口仅适用于客户端环境。<br><br>*调用频率...
klaviyo-pp-cli client create-review - — 根据提供的
klaviyo-pp-cli client create-subscription和...创建邮件和/或SMS渠道的订阅及同意记录email - — 获取账户内所有地理围栏。返回指定公司的所有地理围栏分页列表。这是正式版...
klaviyo-pp-cli client get-geofences - — 获取账户内所有评论数值报告。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli client get-review-values-reports<br>稳定:10/s150/m - — 获取所有评论。该接口仅适用于客户端环境,服务端使用请参考...
klaviyo-pp-cli client get-reviews - — 注销推送令牌。该接口专门设计用于从我们的移动SDK调用...
klaviyo-pp-cli client unregister-push-token
conversation-messages — 对话消息管理
- — 向对话发送出站消息。需要OAuth认证和账户级启用。如需请求...
klaviyo-pp-cli conversation-messages
coupon-code-bulk-create-jobs — 优惠券代码批量创建任务管理
- — 创建优惠券代码批量创建任务,批量生成优惠券代码。每个任务最多支持的优惠券代码数量为...
klaviyo-pp-cli coupon-code-bulk-create-jobs bulk-create-coupon-codes - — 获取所有优惠券代码批量创建任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
klaviyo-pp-cli coupon-code-bulk-create-jobs get-bulk-create-coupon-code-jobs - — 根据给定任务ID获取优惠券代码批量创建任务。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli coupon-code-bulk-create-jobs get-bulk-create-coupon-codes-job<br>稳定:75/s...750/m
coupon-codes — 优惠券代码管理
- — 为给定优惠券同步创建优惠券代码。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli coupon-codes create<br>稳定:...350/s - — 根据给定标识符同步删除优惠券代码。如果用户档案已分配该优惠券...
klaviyo-pp-cli coupon-codes delete - — 获取与优惠券/多个优惠券或用户档案/多个用户档案关联的优惠券代码列表。需提供优惠券/多个优惠券或...
klaviyo-pp-cli coupon-codes get - — 根据给定标识符返回优惠券代码。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli coupon-codes get-couponcodes<br>稳定:350/s...3500/m - — 根据给定标识符同步更新优惠券代码。我们允许更新'status'和...
klaviyo-pp-cli coupon-codes update
coupons — 优惠券管理
- — 创建新优惠券。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli coupons create<br>稳定:3/s权限范围:60/mcoupons:write - — 根据给定优惠券ID删除优惠券。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli coupons delete<br>稳定:3/s权限范围:...60/m - — 获取账户内所有优惠券。如需了解更多,请查看我们的[优惠券API...
klaviyo-pp-cli coupons get - — 根据给定优惠券ID获取特定优惠券。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli coupons get-id<br>稳定:75/s...750/m - — 调用频率限制:<br>突发:
klaviyo-pp-cli coupons update<br>稳定:3/s权限范围:60/mcoupons:write
custom-metrics — 自定义指标管理
- — 创建新的自定义指标。自定义指标对象必须包含
klaviyo-pp-cli custom-metrics create和name。<br><br>*调用频率...definition - — 根据给定自定义指标ID删除自定义指标。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli custom-metrics delete<br>稳定:3/s...60/m - — 获取账户内所有自定义指标。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli custom-metrics get<br>稳定:3/s权限范围:60/mmetrics:read - — 根据给定自定义指标ID获取自定义指标。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli custom-metrics get-custommetrics<br>稳定:3/s...60/m - — 根据给定自定义指标ID更新自定义指标。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli custom-metrics update<br>稳定:...1/s
data-privacy-deletion-jobs — 数据隐私删除任务管理
- — 请求删除与以下标识符对应的用户档案:
klaviyo-pp-cli data-privacy-deletion-jobs、email或...phone_number
data-source-record-bulk-create-jobs — 数据源记录批量创建任务管理
- — 创建批量数据源记录导入任务,批量创建记录。每次请求最多支持500条记录。该...
klaviyo-pp-cli data-source-record-bulk-create-jobs
data-source-record-create-jobs — 数据源记录创建任务管理
- — 创建数据源记录导入任务,创建单条记录。每条记录的最大允许负载大小为...
klaviyo-pp-cli data-source-record-create-jobs
data-sources — 数据源管理
- — 在账户内创建新数据源<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli data-sources create<br>稳定:3/s权限范围:...60/m - — 删除账户内的数据源。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli data-sources delete<br>稳定:3/s权限范围:...60/m - — 获取账户内所有数据源。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli data-sources get<br>稳定:3/s权限范围:...60/m - — 获取账户内的数据源。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli data-sources get-datasources<br>稳定:3/s权限范围:...60/m
event-bulk-create-jobs — 事件批量创建任务管理
- — 为一个或多个用户档案创建批量事件。注意:该接口允许创建新用户档案或...
klaviyo-pp-cli event-bulk-create-jobs
events — 事件管理
- — 创建新事件以追踪用户档案的活动。注意:该接口允许创建新用户档案或...
klaviyo-pp-cli events create - — 获取账户内所有事件。请求可按以下字段排序:
klaviyo-pp-cli events get、datetime[自定义...timestamp - — 根据给定事件ID获取事件。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli events get-id<br>稳定:10/s权限范围:...150/m
flow-actions — 自动化流程操作管理
- — 根据给定流程操作ID获取自动化流程中的操作。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli flow-actions get<br>稳定:3/s...60/m - — 更新自动化流程操作。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli flow-actions update<br>稳定:3/s权限范围:60/mflows:write
flow-messages — 自动化流程消息管理
- — 根据给定流程消息ID获取自动化流程中的消息。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli flow-messages <id><br>稳定:...3/s
flow-series-reports — 自动化流程系列报告管理
- — 返回请求的自动化流程分析系列数据<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli flow-series-reports<br>稳定:1/s<br>每日:...2/m
flow-values-reports — 自动化流程数值报告管理
- — 返回请求的自动化流程分析数值数据<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli flow-values-reports<br>稳定:1/s<br>每日:...2/m
flows — 自动化流程管理
- — 使用编码的流程定义创建新自动化流程。流程定义中的新对象(如操作)将...
klaviyo-pp-cli flows create - — 根据给定流程ID删除自动化流程。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli flows delete<br>稳定:3/s权限范围:60/mflows:write - — 获取账户内所有自动化流程。每次请求最多返回50个流程,可通过基于游标...分页
klaviyo-pp-cli flows get - — 根据给定流程ID获取自动化流程。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli flows get-id<br>稳定:3/s权限范围:60/mflows:read - — 根据给定流程ID更新自动化流程的状态及其中的所有操作。<br><br>调用频率限制:<br>突发:...
klaviyo-pp-cli flows update
form-series-reports — 表单系列报告管理
- — 返回请求的表单分析系列数据。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli form-series-reports<br>稳定:1/s<br>每日:...2/m
form-values-reports — 表单数值报告管理
- — 返回请求的表单分析数值数据。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli form-values-reports<br>稳定:1/s<br>每日:...2/m
form-versions — 表单版本管理
- — 根据给定ID获取表单版本。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli form-versions <id><br>稳定:3/s权限范围:60/mforms:read
forms — 表单管理
- — 创建新表单。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli forms create<br>稳定:3/s权限范围:60/mforms:write - — 删除给定表单。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli forms delete<br>稳定:3/s权限范围:60/mforms:write - — 获取账户内所有表单。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli forms get<br>稳定:3/s权限范围:60/mforms:read - — 根据给定ID获取表单。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli forms get-id<br>稳定:3/s权限范围:60/mforms:read
image-upload — 图片上传管理
- — 从文件上传图片。如果要从现有URL或数据URI导入图片,请使用“从URL上传图片...
klaviyo-pp-cli image-upload
images — 图片管理
- — 获取账户内所有图片。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli images get<br>稳定:10/s权限范围:150/mimages:read - — 根据给定图片ID获取图片。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli images get-id<br>稳定:10/s权限范围:...150/m - — 根据给定图片ID更新图片。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli images update<br>稳定:10/s权限范围:...150/m - — 从URL或数据URI导入图片。如果要从文件上传图片,请使用“从文件上传图片...
klaviyo-pp-cli images upload-from-url
lists — 用户列表管理
- — 创建新用户列表。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli lists create<br>稳定:10/s<br>每日:150/m权限范围:150/dlists:write - — 根据给定列表ID删除用户列表。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli lists delete<br>稳定:10/s权限范围:...150/m - — 获取账户内所有用户列表。可筛选请求部分用户列表。用户列表可按
klaviyo-pp-cli lists get、id、...筛选name - — 根据给定列表ID获取用户列表。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli lists get-id<br>稳定:75/s<br><br>调用频率限制在...750/m - — 根据给定列表ID更新用户列表名称。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli lists update<br>稳定:10/s...150/m
mapped-metrics — 映射指标管理
- — 获取账户内所有映射指标。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli mapped-metrics get<br>稳定:3/s权限范围:60/mmetrics:read - — 根据给定ID获取映射指标。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli mapped-metrics get-mappedmetrics<br>稳定:3/s权限范围:...60/m - — 根据给定ID更新映射指标。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli mapped-metrics update<br>稳定:1/s<br>每日:15/m...30/d
metric-aggregates — 指标聚合管理
- — 查询并聚合与指标关联的事件数据,包括Klaviyo原生指标、集成特定...
klaviyo-pp-cli metric-aggregates
metric-properties — 指标属性管理
- — 根据给定指标属性ID获取指标属性。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli metric-properties <id><br>稳定:1/s...15/m
metrics — 指标管理
- — 获取账户内所有指标。请求可按以下字段筛选:集成
klaviyo-pp-cli metrics get、集成...name - — 根据给定指标ID获取指标。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli metrics get-id<br>稳定:10/s权限范围:...150/m
profile-bulk-import-jobs — 用户档案批量导入任务管理
- — 创建用户档案批量导入任务,批量创建或更新用户档案。每次请求最多支持10000个用户档案....
klaviyo-pp-cli profile-bulk-import-jobs bulk-import-profiles - — 根据给定任务ID获取用户档案批量导入任务。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-job<br>稳定:10/s...150/m - — 获取所有用户档案批量导入任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-jobs
profile-import — 用户档案导入管理
- — 根据一组用户档案属性(可选包含ID)创建或更新用户档案。如果创建了新用户档案,返回201...
klaviyo-pp-cli profile-import
profile-merge — 用户档案合并管理
- — 将给定关联用户档案合并到指定ID的用户档案中。
klaviyo-pp-cli profile-merge下提供的用户档案...relationships
profile-subscription-bulk-create-jobs — 用户档案订阅批量创建任务管理
- — 订阅一个或多个用户档案接收邮件营销、SMS营销、WhatsApp或推送通知。如果提供的列表包含重复...
klaviyo-pp-cli profile-subscription-bulk-create-jobs
profile-subscription-bulk-delete-jobs — 用户档案订阅批量删除任务管理
- — > 🚧 > > 不在指定列表中的用户档案将被全局取消订阅。请始终验证用户档案列表归属...
klaviyo-pp-cli profile-subscription-bulk-delete-jobs
profile-suppression-bulk-create-jobs — 用户档案批量抑制任务管理
- — 通过邮箱地址手动抑制用户档案,或指定细分/列表ID抑制该细分/列表的所有当前成员...
klaviyo-pp-cli profile-suppression-bulk-create-jobs bulk-suppress-profiles - — 根据给定任务ID获取用户档案批量抑制任务。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-job<br>稳定:75/s...750/m - — 获取所有用户档案批量抑制任务的状态。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-jobs<br>稳定:75/s...750/m
profile-suppression-bulk-delete-jobs — 用户档案批量取消抑制任务管理
- — 通过邮箱地址手动取消抑制用户档案,或指定细分/列表ID取消抑制该细分/列表的所有当前成员...
klaviyo-pp-cli profile-suppression-bulk-delete-jobs bulk-unsuppress-profiles - — 根据给定任务ID获取用户档案批量取消抑制任务。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-job<br>稳定:...75/s - — 获取所有用户档案批量取消抑制任务。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-jobs<br>稳定:75/s权限范围:...750/m
profiles — 用户档案管理
- — 创建新用户档案。使用
klaviyo-pp-cli profiles create参数可包含订阅和预测分析数据...additional-fields - — 获取账户内所有用户档案。用户档案可按以下字段进行升序或降序排序...
klaviyo-pp-cli profiles get - — 根据给定用户档案ID获取用户档案。使用
klaviyo-pp-cli profiles get-id参数可包含订阅和...additional-fields - — 根据给定用户档案ID更新用户档案。使用
klaviyo-pp-cli profiles update参数可包含订阅和...additional-fields
push-tokens — 推送令牌管理
- — 创建或更新推送令牌。该接口可用于将推送令牌从其他平台迁移到Klaviyo....
klaviyo-pp-cli push-tokens create - — 根据ID删除特定推送令牌。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli push-tokens delete<br>稳定:3/s权限范围:...60/m - — 返回与公司关联的推送令牌。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli push-tokens get<br>稳定:10/s权限范围:...150/m - — 根据ID返回特定推送令牌。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli push-tokens get-pushtokens<br>稳定:10/s权限范围:...150/m
reviews — 评论管理
- — 获取所有评论。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli reviews get<br>稳定:10/s权限范围:150/mreviews:read - — 根据给定ID获取评论。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli reviews get-id<br>稳定:10/s权限范围:150/mreviews:read - — 更新评论。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli reviews update<br>稳定:10/s权限范围:150/mreviews:write
segment-series-reports — 用户细分系列报告管理
- — 返回请求的用户细分分析系列数据。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli segment-series-reports<br>稳定:...1/s
segment-values-reports — 用户细分数值报告管理
- — 返回请求的用户细分分析数值数据。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli segment-values-reports<br>稳定:...1/s
segments — 用户细分管理
- — 创建用户细分。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli segments create<br>稳定:1/s<br>每日:15/m权限范围:100/dsegments:write - — 根据给定细分ID删除用户细分。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli segments delete<br>稳定:3/s权限范围:...60/m - — 获取账户内所有用户细分。可筛选请求部分用户细分。用户细分可按
klaviyo-pp-cli segments get、...筛选name - — 根据给定细分ID获取用户细分。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli segments get-id<br>稳定:75/s<br><br>调用频率...750/m - — 根据给定细分ID更新用户细分。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli segments update<br>稳定:1/s<br>每日:...15/m
tag-groups — 标签组管理
- — 创建标签组。一个账户最多可拥有50个唯一标签组。如果未指定
klaviyo-pp-cli tag-groups create...exclusive - — 根据给定标签组ID删除标签组。该标签组内的所有标签以及标签与其他资源的关联将...
klaviyo-pp-cli tag-groups delete - — 列出账户内所有标签组。每个账户都有一个默认标签组。标签组可按
klaviyo-pp-cli tag-groups get、...筛选name - — 根据给定标签组ID获取标签组。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli tag-groups get-taggroups<br>稳定:3/s...60/m - — 根据给定标签组ID更新标签组。仅可修改标签组的
klaviyo-pp-cli tag-groups update。标签组的...name
tags — 标签管理
- — 创建标签。一个账户最多可拥有500个唯一标签。标签属于单个标签组。如果...
klaviyo-pp-cli tags create - — 根据给定标签ID删除标签。标签与其他资源的所有关联也将...
klaviyo-pp-cli tags delete - — 列出账户内所有标签。标签可按
klaviyo-pp-cli tags get筛选,并按name或name进行升序或降序排序...id - — 根据给定标签ID获取标签。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli tags get-id<br>稳定:3/s权限范围:60/mtags:read - — 根据给定标签ID更新标签。仅可修改标签的
klaviyo-pp-cli tags update。标签无法从一个标签组...name
template-clone — 模板克隆管理
- — 根据给定模板ID创建模板克隆。如果账户内已有1000个或更多模板,克隆...
klaviyo-pp-cli template-clone
template-render — 模板渲染管理
- — 根据给定模板ID和上下文属性渲染模板。返回AMP、HTML和纯文本版本...
klaviyo-pp-cli template-render
template-universal-content — 模板通用内容管理
- — 创建通用内容。目前支持的块类型包括:
klaviyo-pp-cli template-universal-content create-universal-content、button、drop_shadow、horizontal_rule、...html - — 根据给定ID删除通用内容。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli template-universal-content delete-universal-content<br>稳定:75/s...750/m - — 获取账户内所有通用内容。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli template-universal-content get-all-universal-content<br>稳定:75/s权限范围:...750/m - — 根据给定ID获取通用内容。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli template-universal-content get-universal-content<br>稳定:75/s权限范围:...750/m - — 更新通用内容。目前仅可更新以下块类型的
klaviyo-pp-cli template-universal-content update-universal-content字段:...definition
templates — 模板管理
- — 创建新的HTML或拖拽式模板。如果账户内已有1000个或更多模板,创建将失败...
klaviyo-pp-cli templates create - — 根据给定模板ID删除模板。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli templates delete<br>稳定:75/s权限范围:...750/m - — 获取账户内所有模板。使用
klaviyo-pp-cli templates get可包含完整模板...additional-fields[template]=definition - — 根据给定模板ID获取模板。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli templates get-id<br>稳定:75/s权限范围:...750/m - — 根据给定模板ID更新模板。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli templates update<br>稳定:75/s权限范围:...750/m
tracking-settings — 追踪设置管理
- — 获取账户内所有UTM追踪设置。返回包含单个追踪设置的数组。更多关于...的信息
klaviyo-pp-cli tracking-settings get - — 根据给定账户ID获取UTM追踪设置。更多关于UTM追踪设置的信息可查看...
klaviyo-pp-cli tracking-settings get-trackingsettings - — 根据给定账户ID更新UTM追踪设置。更多关于UTM追踪设置的信息可查看...
klaviyo-pp-cli tracking-settings update
web-feeds — 网页源管理
- — 创建网页源。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli web-feeds create<br>稳定:1/s权限范围:15/mweb-feeds:write - — 根据给定ID删除网页源。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli web-feeds delete<br>稳定:1/s权限范围:...15/m - — 获取账户内所有网页源。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli web-feeds get<br>稳定:1/s权限范围:15/mweb-feeds:read - — 根据给定ID获取网页源。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli web-feeds get-webfeeds<br>稳定:1/s权限范围:15/mweb-feeds:read - — 根据给定ID更新网页源。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli web-feeds update<br>稳定:1/s权限范围:...15/m
webhook-topics — Webhook主题管理
- — 获取Klaviyo账户内所有Webhook主题。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli webhook-topics get<br>稳定:1/s权限范围:...15/m - — 根据给定ID获取Webhook主题。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli webhook-topics get-webhooktopics<br>稳定:1/s权限范围:...15/m
webhooks — Webhook管理
- — 创建新Webhook<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli webhooks create<br>稳定:1/s权限范围:15/mwebhooks:write - — 根据给定ID删除Webhook。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli webhooks delete<br>稳定:1/s权限范围:15/mwebhooks:write - — 获取账户内所有Webhook。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli webhooks get<br>稳定:1/s权限范围:15/mwebhooks:read - — 根据给定ID获取Webhook。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli webhooks get-id<br>稳定:1/s权限范围:15/mwebhooks:read - — 根据给定ID更新Webhook。<br><br>调用频率限制:<br>突发:
klaviyo-pp-cli webhooks update<br>稳定:1/s权限范围:...15/m
Finding the right command
查找合适的命令
When you know what you want to do but not which command does it, ask the CLI directly:
bash
klaviyo-pp-cli which "<capability in your own words>"which02--help当你知道要执行的操作但不知道对应的命令时,可直接询问CLI:
bash
klaviyo-pp-cli which "<用自己的话描述功能>"which02--helpRecipes
使用示例
Inspect a profile compactly
简洁查看用户档案
bash
klaviyo-pp-cli profiles list --limit 1 --json --select data.id,data.email,data.first_nameFetch one profile and select only the fields an agent needs.
bash
klaviyo-pp-cli profiles list --limit 1 --json --select data.id,data.email,data.first_name获取一个用户档案并仅选择代理所需的字段。
Find a revenue metric
查找收益指标
bash
klaviyo-pp-cli metrics list --json --select data.id,data.name | jq '.data[] | select(.name=="Placed Order")'Locate the Placed Order metric before attribution or cohort work.
bash
klaviyo-pp-cli metrics list --json --select data.id,data.name | jq '.data[] | select(.name=="Placed Order")'在进行归因或群组分析前定位“Placed Order”指标。
Run a launch QA gate
运行上线QA检查
bash
klaviyo-pp-cli plan qa-gate --campaign-id CAMPAIGN_ID --jsonReview offer, link, compliance, date, and deliverability findings before launch.
bash
klaviyo-pp-cli plan qa-gate --campaign-id CAMPAIGN_ID --json在上线前检查优惠、链接、合规性、日期及送达性相关问题。
Auth Setup
认证设置
Set KLAVIYO_API_KEY to a private Klaviyo API key. Requests send Authorization: Klaviyo-API-Key <token> and use the revision pinned by the generated OpenAPI spec.
Run to verify setup.
klaviyo-pp-cli doctor将KLAVIYO_API_KEY设置为Klaviyo私有API密钥。请求将发送Authorization: Klaviyo-API-Key <token>,并使用生成的OpenAPI规范固定的版本。
运行验证设置是否正确。
klaviyo-pp-cli doctorAgent Mode
代理模式
Add to any command. Expands to: .
--agent--json --compact --no-input --no-color --yes-
Pipeable — JSON on stdout, errors on stderr
-
Filterable —keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:
--selectbashklaviyo-pp-cli accounts get --agent --select id,name,status -
Previewable —shows the request without sending
--dry-run -
Offline-friendly — sync/search commands can use the local SQLite store when available
-
Non-interactive — never prompts, every input is a flag
在任何命令后添加参数。该参数等价于:。
--agent--json --compact --no-input --no-color --yes-
可管道化 — 标准输出为JSON,错误信息输出到标准错误
-
可筛选 —参数保留部分字段。点路径可深入嵌套结构;数组按元素遍历。对于冗长的API,这是缩小上下文范围的关键:
--selectbashklaviyo-pp-cli accounts get --agent --select id,name,status -
可预览 —参数显示请求内容但不发送
--dry-run -
离线友好 — 同步/搜索命令可在本地SQLite存储可用时使用该存储
-
非交互式 — 从不提示,所有输入均通过标志参数提供
Response envelope
响应信封
Commands that read from the local store or the API wrap output in a provenance envelope:
json
{
"meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
"results": <data>
}Parse for data and to know whether it's live or local. A human-readable summary is printed to stderr only when stdout is a terminal — piped/agent consumers get pure JSON on stdout.
.results.meta.sourceN results (live)从本地存储或API读取数据的命令会将输出包装在来源信封中:
json
{
"meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
"results": <data>
}解析获取数据,用于判断数据是实时的还是本地的。仅当标准输出为终端时,才会在标准错误输出中打印人类可读的摘要 — 管道/代理消费者仅会在标准输出获取纯JSON。
.results.meta.sourceN results (live)Agent Feedback
代理反馈
When you (or the agent) notice something off about this CLI, record it:
klaviyo-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
klaviyo-pp-cli feedback --stdin < notes.txt
klaviyo-pp-cli feedback list --json --limit 10Entries are stored locally at . They are never POSTed unless is set AND either is passed or . Default behavior is local-only.
~/.klaviyo-pp-cli/feedback.jsonlKLAVIYO_FEEDBACK_ENDPOINT--sendKLAVIYO_FEEDBACK_AUTO_SEND=trueWrite what surprised you, not a bug report. Short, specific, one line: that is the part that compounds.
当你(或代理)发现此CLI存在问题时,可记录反馈:
klaviyo-pp-cli feedback "the --since flag is inclusive but docs say exclusive"
klaviyo-pp-cli feedback --stdin < notes.txt
klaviyo-pp-cli feedback list --json --limit 10反馈条目存储在本地文件中。仅当设置了且传递了参数或时,反馈才会被POST发送。默认行为仅存储在本地。
~/.klaviyo-pp-cli/feedback.jsonlKLAVIYO_FEEDBACK_ENDPOINT--sendKLAVIYO_FEEDBACK_AUTO_SEND=true请记录让你感到意外的内容,而非正式的错误报告。简短、具体、单条内容:这样的反馈会更有价值。
Output Delivery
输出交付
Every command accepts . The output goes to the named sink in addition to (or instead of) stdout, so agents can route command results without hand-piping. Three sinks are supported:
--deliver <sink>| Sink | Effect |
|---|---|
| Default; write to stdout only |
| Atomically write output to |
| POST the output body to the URL ( |
Unknown schemes are refused with a structured error naming the supported set. Webhook failures return non-zero and log the URL + HTTP status on stderr.
每个命令都支持参数。输出会发送到指定的sink,同时也会(或替代)发送到标准输出,因此代理无需手动管道即可路由命令结果。支持三种sink:
--deliver <sink>| Sink | 效果 |
|---|---|
| 默认;仅输出到标准输出 |
| 原子性地将输出写入 |
| 将输出体POST到指定URL(当使用 |
未知的协议会被拒绝,并返回结构化错误说明支持的协议类型。Webhook失败时返回非零退出码,并在标准错误输出中记录URL和HTTP状态码。
Named Profiles
命名配置文件
A profile is a saved set of flag values, reused across invocations. Use it when a scheduled agent calls the same command every run with the same configuration - HeyGen's "Beacon" pattern.
klaviyo-pp-cli profile save briefing --json
klaviyo-pp-cli --profile briefing accounts get
klaviyo-pp-cli profile list --json
klaviyo-pp-cli profile show briefing
klaviyo-pp-cli profile delete briefing --yesExplicit flags always win over profile values; profile values win over defaults. lists all available profiles under so introspecting agents discover them at runtime.
agent-contextavailable_profiles配置文件是一组保存的标志值,可在多次调用中复用。当调度代理每次运行都使用相同配置调用同一命令时,可使用此功能 — 即HeyGen的“Beacon”模式。
klaviyo-pp-cli profile save briefing --json
klaviyo-pp-cli --profile briefing accounts get
klaviyo-pp-cli profile list --json
klaviyo-pp-cli profile show briefing
klaviyo-pp-cli profile delete briefing --yes显式标志始终优先于配置文件值;配置文件值优先于默认值。会在下列出所有可用配置文件,因此自省代理可在运行时发现这些配置文件。
agent-contextavailable_profilesExit Codes
退出码
| Code | Meaning |
|---|---|
| 0 | Success |
| 2 | Usage error (wrong arguments) |
| 3 | Resource not found |
| 4 | Authentication required |
| 5 | API error (upstream issue) |
| 7 | Rate limited (wait and retry) |
| 10 | Config error |
| 代码 | 含义 |
|---|---|
| 0 | 成功 |
| 2 | 使用错误(参数错误) |
| 3 | 资源未找到 |
| 4 | 需要认证 |
| 5 | API错误(上游问题) |
| 7 | 调用频率受限(等待后重试) |
| 10 | 配置错误 |
Argument Parsing
参数解析
Parse :
$ARGUMENTS- Empty, , or
help→ show--helpoutputklaviyo-pp-cli --help - Starts with → ends with
install→ MCP installation; otherwise → see Prerequisites abovemcp - Anything else → Direct Use (execute as CLI command with )
--agent
解析:
$ARGUMENTS- 为空、或
help→ 显示--help输出klaviyo-pp-cli --help - 以开头 → 以
install结尾 → MCP安装;否则 → 参考上方前置条件mcp - 其他内容 → 直接使用(添加参数执行CLI命令)
--agent
MCP Server Installation
MCP服务器安装
- Install the MCP server:
bash
go install github.com/mvanhorn/printing-press-library/library/marketing/klaviyo/cmd/klaviyo-pp-mcp@latest - Register with Claude Code:
bash
claude mcp add klaviyo-pp-mcp -- klaviyo-pp-mcp - Verify:
claude mcp list
- 安装MCP服务器:
bash
go install github.com/mvanhorn/printing-press-library/library/marketing/klaviyo/cmd/klaviyo-pp-mcp@latest - 在Claude Code中注册:
bash
claude mcp add klaviyo-pp-mcp -- klaviyo-pp-mcp - 验证:
claude mcp list
Direct Use
直接使用
- Check if installed: If not found, offer to install (see Prerequisites at the top of this skill).
which klaviyo-pp-cli - Match the user query to the best command from the Unique Capabilities and Command Reference above.
- Execute with the flag:
--agentbashklaviyo-pp-cli <command> [subcommand] [args] --agent - If ambiguous, drill into subcommand help: .
klaviyo-pp-cli <command> --help
- 检查是否安装:如果未找到,提供安装选项(参考本技能顶部的前置条件)。
which klaviyo-pp-cli - 将用户查询与上方独特功能和命令参考中最匹配的命令对应。
- 添加参数执行:
--agentbashklaviyo-pp-cli <command> [subcommand] [args] --agent - 如果存在歧义,查看子命令帮助:。
klaviyo-pp-cli <command> --help