pp-klaviyo

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Klaviyo — Printing Press CLI

Klaviyo — Printing Press CLI

Prerequisites: Install the CLI

前置条件:安装CLI

This skill drives the
klaviyo-pp-cli
binary. You must verify the CLI is installed before invoking any command from this skill. If it is missing, install it first:
  1. Install via the Printing Press installer:
    bash
    npx -y @mvanhorn/printing-press install klaviyo --cli-only
  2. Verify:
    klaviyo-pp-cli --version
  3. Ensure
    $GOPATH/bin
    (or
    $HOME/go/bin
    ) is on
    $PATH
    .
If the
npx
install fails (no Node, offline, etc.), fall back to a direct Go install (requires Go 1.23+):
bash
go install github.com/mvanhorn/printing-press-library/library/marketing/klaviyo/cmd/klaviyo-pp-cli@latest
If
--version
reports "command not found" after install, the install step did not put the binary on
$PATH
. Do not proceed with skill commands until verification succeeds.
本技能基于
klaviyo-pp-cli
二进制文件运行。在调用本技能的任何命令前,你必须确认CLI已安装。 如果未安装,请先执行以下步骤:
  1. 通过Printing Press安装器安装:
    bash
    npx -y @mvanhorn/printing-press install klaviyo --cli-only
  2. 验证安装:
    klaviyo-pp-cli --version
  3. 确保
    $GOPATH/bin
    (或
    $HOME/go/bin
    )已添加到
    $PATH
    环境变量中。
如果
npx
安装失败(如无Node环境、离线等),可改用Go直接安装(要求Go 1.23及以上版本):
bash
go install github.com/mvanhorn/printing-press-library/library/marketing/klaviyo/cmd/klaviyo-pp-cli@latest
如果安装后执行
--version
提示“command not found”,说明安装未将二进制文件添加到
$PATH
中。请在验证成功前不要执行技能命令。

When 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

营销活动操作

  • campaigns deploy
    — Create an email template, create a draft campaign, and assign the template to the campaign message in one audited workflow.
    Agents can build a draft campaign without hand-stitching three endpoint calls.
    bash
    klaviyo-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
  • campaigns image-swap
    — Find a campaign message template and replace an image URL inside the HTML while preserving the rest of the draft.
    Agents can make safe creative swaps without rebuilding a whole campaign.
    bash
    klaviyo-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
    — 在一个可审计的工作流中完成创建邮件模板、创建营销活动草稿、将模板分配给营销活动消息的全部操作。
    无需手动拼接三次接口调用,即可创建营销活动草稿。
    bash
    klaviyo-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
  • campaigns image-swap
    — 查找营销活动消息模板,替换其中的图片URL,同时保留草稿的其他内容。
    无需重建整个营销活动,即可安全替换创意素材。
    bash
    klaviyo-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

行为图谱分析

  • flow-decay
    — Identify flows whose open or click performance has decayed across recent time buckets using synced local data.
    Agents can spot lifecycle automations that need refresh before revenue falls further.
    bash
    klaviyo-pp-cli flow-decay --days 90 --threshold 0.15 --json
  • cohort
    — Group profiles by first event date and compute retention or repeat-action curves from synced profiles and events.
    Agents can answer which acquisition cohorts keep buying without exporting CSVs.
    bash
    klaviyo-pp-cli cohort --metric "Placed Order" --interval month --json --select cohort,profiles,retained
  • attribution
    — Join order events with campaign and flow attribution properties to summarize revenue by channel and source.
    Agents can explain which automation or campaign generated revenue using local event evidence.
    bash
    klaviyo-pp-cli attribution --metric "Placed Order" --group-by flow --since 2026-01-01 --json
  • flow-decay
    — 使用同步的本地数据,识别近期时间区间内打开率或点击率下降的自动化流程。
    可在收益进一步下滑前发现需要优化的生命周期自动化流程。
    bash
    klaviyo-pp-cli flow-decay --days 90 --threshold 0.15 --json
  • cohort
    — 按首次事件日期对用户档案分组,并根据同步的用户档案和事件计算留存率或重复行为曲线。
    无需导出CSV即可分析哪些获客群组持续产生购买行为。
    bash
    klaviyo-pp-cli cohort --metric "Placed Order" --interval month --json --select cohort,profiles,retained
  • attribution
    — 将订单事件与营销活动和自动化流程的归因属性关联,按渠道和来源汇总收益。
    可通过本地事件数据说明哪些自动化流程或营销活动产生了收益。
    bash
    klaviyo-pp-cli attribution --metric "Placed Order" --group-by flow --since 2026-01-01 --json

Data hygiene

数据清洁

  • dedup
    — Find profiles that appear duplicated by email, phone, or cross-channel collisions in the local profile mirror.
    Agents can flag customer records that split behavior and revenue history across identities.
    bash
    klaviyo-pp-cli dedup --by email,phone --json
  • reconcile
    — Compare campaign UTM evidence with local Klaviyo order events and optional Shopify credentials when available.
    Agents can check whether campaign performance agrees with order evidence before reporting numbers.
    bash
    klaviyo-pp-cli reconcile --campaign-id CAMPAIGN_ID --since 2026-01-01 --json
  • dedup
    — 在本地用户档案镜像中查找因邮箱、电话或跨渠道冲突导致的重复用户档案。
    可标记那些在不同身份下拆分行为和收益历史的客户记录。
    bash
    klaviyo-pp-cli dedup --by email,phone --json
  • reconcile
    — 对比营销活动UTM数据与本地Klaviyo订单事件,若有Shopify凭证也可一并使用。
    在上报数据前,可检查营销活动表现与订单数据是否一致。
    bash
    klaviyo-pp-cli reconcile --campaign-id CAMPAIGN_ID --since 2026-01-01 --json

Growth planning

增长规划

  • plan brief-to-strategy
    — Turn a growth brief into a structured Klaviyo campaign, flow, segment, and experiment strategy.
    Agents can convert strategy notes into a concrete Klaviyo execution plan.
    bash
    klaviyo-pp-cli plan brief-to-strategy --brief ./brief.md --json
  • plan qa-gate
    — Run a launch-readiness checklist for links, offers, dates, timezone, fallback tokens, compliance, and deliverability flags.
    Agents can block risky campaign launches with explicit findings instead of vague review notes.
    bash
    klaviyo-pp-cli plan qa-gate --campaign-id CAMPAIGN_ID --json
  • plan brief-to-strategy
    — 将增长简报转化为结构化的Klaviyo营销活动、自动化流程、用户细分及实验策略。
    可将战略笔记转化为具体的Klaviyo执行计划。
    bash
    klaviyo-pp-cli plan brief-to-strategy --brief ./brief.md --json
  • plan qa-gate
    — 针对链接、优惠、日期、时区、回退令牌、合规性及送达性标志运行启动就绪检查清单。
    可通过明确的检查结果阻止高风险营销活动上线,而非模糊的审核备注。
    bash
    klaviyo-pp-cli plan qa-gate --campaign-id CAMPAIGN_ID --json

Command Reference

命令参考

accounts — accounts
  • klaviyo-pp-cli accounts get
    — 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-id
    — Retrieve a single account object by its account ID. You can only request the account by which the private API key...
back-in-stock-subscriptions — Manage back in stock subscriptions
  • klaviyo-pp-cli back-in-stock-subscriptions
    — Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API...
campaign-clone — Manage campaign clone
  • klaviyo-pp-cli campaign-clone
    — Clones an existing campaign, returning a new campaign based on the original with a new ID and name.<br><br>*Rate...
campaign-message-assign-template — Manage campaign message assign template
  • klaviyo-pp-cli campaign-message-assign-template
    — Creates a non-reusable version of the template and assigns it to the message.<br><br>Rate limits:<br>Burst:...
campaign-messages — Manage campaign messages
  • klaviyo-pp-cli campaign-messages get
    — Returns a specific message based on a required id.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    ...
  • klaviyo-pp-cli campaign-messages update
    — Update a campaign message<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:
    campaigns:write
campaign-recipient-estimation-jobs — Manage campaign recipient estimation jobs
  • klaviyo-pp-cli campaign-recipient-estimation-jobs get
    — Retrieve the status of a recipient estimation job triggered with the
    Create Campaign Recipient Estimation Job
    ...
  • klaviyo-pp-cli campaign-recipient-estimation-jobs refresh-campaign-recipient-estimation
    — Trigger an asynchronous job to update the estimated number of recipients for the given campaign ID. Use the `Get...
campaign-recipient-estimations — Manage campaign recipient estimations
  • klaviyo-pp-cli campaign-recipient-estimations <id>
    — Get the estimated recipient count for a campaign with the provided campaign ID. You can refresh this count by using...
campaign-send-jobs — Manage campaign send jobs
  • klaviyo-pp-cli campaign-send-jobs cancel-campaign-send
    — Permanently cancel the campaign, setting the status to CANCELED or revert the campaign, setting the status back to...
  • klaviyo-pp-cli campaign-send-jobs get
    — Get a campaign send job<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:
    campaigns:read
  • klaviyo-pp-cli campaign-send-jobs send-campaign
    — Trigger a campaign to send asynchronously<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:...
campaign-values-reports — Manage campaign values reports
  • klaviyo-pp-cli campaign-values-reports
    — Returns the requested campaign analytics values data<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:...
campaigns — campaigns
  • klaviyo-pp-cli campaigns create
    — Creates a campaign given a set of parameters, then returns it.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:...
  • klaviyo-pp-cli campaigns delete
    — Delete a campaign with the given campaign ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:...
  • klaviyo-pp-cli campaigns get
    — Returns some or all campaigns based on filters. A channel filter is required to list campaigns. Please provide...
  • klaviyo-pp-cli campaigns get-id
    — Returns a specific campaign based on a required id.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    ...
  • klaviyo-pp-cli campaigns update
    — Update a campaign with the given campaign ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:...
catalog-categories — Manage catalog categories
  • klaviyo-pp-cli catalog-categories create-catalog-category
    — Create a new catalog category.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    Scopes:
    catalogs:write
  • klaviyo-pp-cli catalog-categories delete-catalog-category
    — Delete a catalog category using the given category ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    ...
  • klaviyo-pp-cli catalog-categories get
    — 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-catalog-category
    — Get a catalog category with the given category ID.<br><br>Rate limits:<br>Burst:
    350/s
    <br>Steady:
    3500/m
    ...
  • klaviyo-pp-cli catalog-categories update-catalog-category
    — Update a catalog category with the given category ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    ...
catalog-category-bulk-create-jobs — Manage catalog category bulk create jobs
  • klaviyo-pp-cli catalog-category-bulk-create-jobs bulk-create-catalog-categories
    — 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 get-bulk-create-categories-job
    — Get a catalog category bulk create job with the given job ID. An
    include
    parameter can be provided to get the...
  • klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-jobs
    — Get all catalog category bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate...
catalog-category-bulk-delete-jobs — Manage catalog category bulk delete jobs
  • klaviyo-pp-cli catalog-category-bulk-delete-jobs bulk-delete-catalog-categories
    — 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 get-bulk-delete-categories-job
    — Get a catalog category bulk delete job with the given job ID.<br><br>Rate limits:<br>Burst:
    350/s
    <br>Steady:...
  • klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-jobs
    — Get all catalog category bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate...
catalog-category-bulk-update-jobs — Manage catalog category bulk update jobs
  • klaviyo-pp-cli catalog-category-bulk-update-jobs bulk-update-catalog-categories
    — 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 get-bulk-update-categories-job
    — Get a catalog category bulk update job with the given job ID. An
    include
    parameter can be provided to get the...
  • klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-jobs
    — Get all catalog category bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>*Rate...
catalog-item-bulk-create-jobs — Manage catalog item bulk create jobs
  • klaviyo-pp-cli catalog-item-bulk-create-jobs bulk-create-catalog-items
    — 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 get-bulk-create-catalog-items-job
    — Get a catalog item bulk create job with the given job ID. An
    include
    parameter can be provided to get the...
  • klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-jobs
    — Get all catalog item bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
catalog-item-bulk-delete-jobs — Manage catalog item bulk delete jobs
  • klaviyo-pp-cli catalog-item-bulk-delete-jobs bulk-delete-catalog-items
    — 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 get-bulk-delete-catalog-items-job
    — Get a catalog item bulk delete job with the given job ID.<br><br>Rate limits:<br>Burst:
    350/s
    <br>Steady:...
  • klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-jobs
    — Get all catalog item bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
catalog-item-bulk-update-jobs — Manage catalog item bulk update jobs
  • klaviyo-pp-cli catalog-item-bulk-update-jobs bulk-update-catalog-items
    — 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 get-bulk-update-catalog-items-job
    — Get a catalog item bulk update job with the given job ID. An
    include
    parameter can be provided to get the...
  • klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-jobs
    — Get all catalog item bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
catalog-items — Manage catalog items
  • klaviyo-pp-cli catalog-items create
    — Create a new catalog item.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    Scopes:
    catalogs:write
  • klaviyo-pp-cli catalog-items delete
    — Delete a catalog item with the given item ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    Scopes:...
  • klaviyo-pp-cli catalog-items get
    — 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-catalogitems
    — Get a specific catalog item with the given item ID.<br><br>Rate limits:<br>Burst:
    350/s
    <br>Steady:
    3500/m
    ...
  • klaviyo-pp-cli catalog-items update
    — Update a catalog item with the given item ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    Scopes:...
catalog-variant-bulk-create-jobs — Manage catalog variant bulk create jobs
  • klaviyo-pp-cli catalog-variant-bulk-create-jobs bulk-create-catalog-variants
    — 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 get-bulk-create-variants-job
    — Get a catalog variant bulk create job with the given job ID. An
    include
    parameter can be provided to get the...
  • klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-jobs
    — Get all catalog variant bulk create jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
catalog-variant-bulk-delete-jobs — Manage catalog variant bulk delete jobs
  • klaviyo-pp-cli catalog-variant-bulk-delete-jobs bulk-delete-catalog-variants
    — 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 get-bulk-delete-variants-job
    — Get a catalog variant bulk delete job with the given job ID.<br><br>Rate limits:<br>Burst:
    350/s
    <br>Steady:...
  • klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-jobs
    — Get all catalog variant bulk delete jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
catalog-variant-bulk-update-jobs — Manage catalog variant bulk update jobs
  • klaviyo-pp-cli catalog-variant-bulk-update-jobs bulk-update-catalog-variants
    — 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 get-bulk-update-variants-job
    — Get a catalog variate bulk update job with the given job ID. An
    include
    parameter can be provided to get the...
  • klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-jobs
    — Get all catalog variant bulk update jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
catalog-variants — Manage catalog variants
  • klaviyo-pp-cli catalog-variants create
    — Create a new variant for a related catalog item.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    ...
  • klaviyo-pp-cli catalog-variants delete
    — Delete a catalog item variant with the given variant ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    ...
  • klaviyo-pp-cli catalog-variants get
    — 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-catalogvariants
    — Get a catalog item variant with the given variant ID.<br><br>Rate limits:<br>Burst:
    350/s
    <br>Steady:
    3500/m
    ...
  • klaviyo-pp-cli catalog-variants update
    — Update a catalog item variant with the given variant ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    ...
client — client
  • klaviyo-pp-cli client bulk-create-events
    — Create new events to track a profile's activity. This endpoint is specifically designed to be called from...
  • klaviyo-pp-cli client create-back-in-stock-subscription
    — Subscribe a profile to receive back in stock notifications. Check out [our Back in Stock API...
  • klaviyo-pp-cli client create-event
    — Create a new event to track a profile's activity. This endpoint is specifically designed to be called from...
  • klaviyo-pp-cli client create-profile
    — Create or update properties about a profile without tracking an associated event. This endpoint is specifically...
  • klaviyo-pp-cli client create-push-token
    — Create or update a push token. This endpoint is specifically designed to be called from our mobile SDKs...
  • klaviyo-pp-cli client create-review
    — Create a review with the given ID. This endpoint is for client-side environments only.<br><br>*Rate...
  • klaviyo-pp-cli client create-subscription
    — Creates a subscription and consent record for email and/or SMS channels based on the provided
    email
    and...
  • klaviyo-pp-cli client get-geofences
    — 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-review-values-reports
    — Get all reviews values reports in an account.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
  • klaviyo-pp-cli client get-reviews
    — Get all reviews. This endpoint is for client-side environments only, for server-side use, refer to...
  • klaviyo-pp-cli client unregister-push-token
    — Unregister a push token. This endpoint is specifically designed to be called from our mobile SDKs...
conversation-messages — Manage conversation messages
  • klaviyo-pp-cli conversation-messages
    — Send an outbound message to a conversation. Requires OAuth authentication and account-level enablement. To request...
coupon-code-bulk-create-jobs — Manage coupon code bulk create jobs
  • klaviyo-pp-cli coupon-code-bulk-create-jobs bulk-create-coupon-codes
    — 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 get-bulk-create-coupon-code-jobs
    — 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-codes-job
    — Get a coupon code bulk create job with the given job ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    ...
coupon-codes — Manage coupon codes
  • klaviyo-pp-cli coupon-codes create
    — Synchronously creates a coupon code for the given coupon.<br><br>Rate limits:<br>Burst:
    350/s
    <br>Steady:...
  • klaviyo-pp-cli coupon-codes delete
    — Deletes a coupon code specified by the given identifier synchronously. If a profile has been assigned to the coupon...
  • klaviyo-pp-cli coupon-codes get
    — 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-couponcodes
    — Returns a Coupon Code specified by the given identifier.<br><br>Rate limits:<br>Burst:
    350/s
    <br>Steady:
    3500/m
    ...
  • klaviyo-pp-cli coupon-codes update
    — Updates a coupon code specified by the given identifier synchronously. We allow updating the 'status' and...
coupons — coupons
  • klaviyo-pp-cli coupons create
    — Creates a new coupon.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    coupons:write
  • klaviyo-pp-cli coupons delete
    — Delete the coupon with the given coupon ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:...
  • klaviyo-pp-cli coupons get
    — Get all coupons in an account. To learn more, see our [Coupons API...
  • klaviyo-pp-cli coupons get-id
    — Get a specific coupon with the given coupon ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    ...
  • klaviyo-pp-cli coupons update
    Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    coupons:write
custom-metrics — Manage custom metrics
  • klaviyo-pp-cli custom-metrics create
    — Create a new custom metric. Custom metric objects must include a
    name
    and
    definition
    .<br><br>*Rate...
  • klaviyo-pp-cli custom-metrics delete
    — Delete a custom metric with the given custom metric ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    ...
  • klaviyo-pp-cli custom-metrics get
    — Get all custom metrics in an account.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    metrics:read
  • klaviyo-pp-cli custom-metrics get-custommetrics
    — Get a custom metric with the given custom metric ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    ...
  • klaviyo-pp-cli custom-metrics update
    — Update a custom metric with the given custom metric ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:...
data-privacy-deletion-jobs — Manage data privacy deletion jobs
  • klaviyo-pp-cli data-privacy-deletion-jobs
    — Request a deletion for the profiles corresponding to one of the following identifiers:
    email
    ,
    phone_number
    , or...
data-source-record-bulk-create-jobs — Manage data source record bulk create jobs
  • klaviyo-pp-cli 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...
data-source-record-create-jobs — Manage data source record create jobs
  • klaviyo-pp-cli 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...
data-sources — Manage data sources
  • klaviyo-pp-cli data-sources create
    — Create a new data source in an account<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:...
  • klaviyo-pp-cli data-sources delete
    — Delete a data source in an account.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:...
  • klaviyo-pp-cli data-sources get
    — Get all data sources in an account.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:...
  • klaviyo-pp-cli data-sources get-datasources
    — Retrieve a data source in an account.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:...
event-bulk-create-jobs — Manage event bulk create jobs
  • klaviyo-pp-cli 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...
events — events
  • klaviyo-pp-cli events create
    — 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 get
    — Get all events in an account Requests can be sorted by the following fields:
    datetime
    ,
    timestamp
    [Custom...
  • klaviyo-pp-cli events get-id
    — Get an event with the given event ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:...
flow-actions — Manage flow actions
  • klaviyo-pp-cli flow-actions get
    — Get a flow action from a flow with the given flow action ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    ...
  • klaviyo-pp-cli flow-actions update
    — Update a flow action.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    flows:write
flow-messages — Manage flow messages
  • klaviyo-pp-cli flow-messages <id>
    — Get a flow message from a flow with the given flow message ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:...
flow-series-reports — Manage flow series reports
  • klaviyo-pp-cli flow-series-reports
    — Returns the requested flow analytics series data<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    2/m
    <br>Daily:...
flow-values-reports — Manage flow values reports
  • klaviyo-pp-cli flow-values-reports
    — Returns the requested flow analytics values data<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    2/m
    <br>Daily:...
flows — flows
  • klaviyo-pp-cli flows create
    — Create a new flow using an encoded flow definition. New objects within the flow definition, such as actions, will...
  • klaviyo-pp-cli flows delete
    — Delete a flow with the given flow ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    flows:write
  • klaviyo-pp-cli flows get
    — 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-id
    — Get a flow with the given flow ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    flows:read
  • klaviyo-pp-cli flows update
    — Update the status of a flow with the given flow ID, and all actions in that flow.<br><br>Rate limits:<br>Burst:...
form-series-reports — Manage form series reports
  • klaviyo-pp-cli form-series-reports
    — Returns the requested form analytics series data.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    2/m
    <br>Daily:...
form-values-reports — Manage form values reports
  • klaviyo-pp-cli form-values-reports
    — Returns the requested form analytics values data.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    2/m
    <br>Daily:...
form-versions — Manage form versions
  • klaviyo-pp-cli form-versions <id>
    — Get the form version with the given ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    forms:read
forms — forms
  • klaviyo-pp-cli forms create
    — Create a new form.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    forms:write
  • klaviyo-pp-cli forms delete
    — Delete a given form.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    forms:write
  • klaviyo-pp-cli forms get
    — Get all forms in an account.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    forms:read
  • klaviyo-pp-cli forms get-id
    — Get the form with the given ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    forms:read
image-upload — Manage image upload
  • klaviyo-pp-cli 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...
images — images
  • klaviyo-pp-cli images get
    — Get all images in an account.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:
    images:read
  • klaviyo-pp-cli images get-id
    — Get the image with the given image ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:...
  • klaviyo-pp-cli images update
    — Update the image with the given image ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:...
  • klaviyo-pp-cli images upload-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...
lists — lists
  • klaviyo-pp-cli lists create
    — Create a new list.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    <br>Daily:
    150/d
    Scopes:
    lists:write
  • klaviyo-pp-cli lists delete
    — Delete a list with the given list ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:...
  • klaviyo-pp-cli lists get
    — Get all lists in an account. Filter to request a subset of all lists. Lists can be filtered by
    id
    ,
    name
    ,...
  • klaviyo-pp-cli lists get-id
    — Get a list with the given list ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    <br><br>Rate limits when...
  • klaviyo-pp-cli lists update
    — Update the name of a list with the given list ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    ...
mapped-metrics — Manage mapped metrics
  • klaviyo-pp-cli mapped-metrics get
    — Get all mapped metrics in an account.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    metrics:read
  • klaviyo-pp-cli mapped-metrics get-mappedmetrics
    — Get the mapped metric with the given ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:...
  • klaviyo-pp-cli mapped-metrics update
    — Update the mapped metric with the given ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    <br>Daily:
    30/d
    ...
metric-aggregates — Manage metric aggregates
  • klaviyo-pp-cli metric-aggregates
    — Query and aggregate event data associated with a metric, including native Klaviyo metrics, integration-specific...
metric-properties — Manage metric properties
  • klaviyo-pp-cli metric-properties <id>
    — Get a metric property with the given metric property ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    ...
metrics — metrics
  • klaviyo-pp-cli metrics get
    — Get all metrics in an account. Requests can be filtered by the following fields: integration
    name
    , integration...
  • klaviyo-pp-cli metrics get-id
    — Get a metric with the given metric ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:...
profile-bulk-import-jobs — Manage profile bulk import jobs
  • klaviyo-pp-cli profile-bulk-import-jobs bulk-import-profiles
    — 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 get-bulk-import-profiles-job
    — Get a bulk profile import job with the given job ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    ...
  • klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-jobs
    — Get all bulk profile import jobs. Returns a maximum of 100 jobs per request.<br><br>Rate limits:<br>Burst:...
profile-import — Manage profile import
  • klaviyo-pp-cli profile-import
    — Given a set of profile attributes and optionally an ID, create or update a profile. Returns 201 if a new profile was...
profile-merge — Manage profile merge
  • klaviyo-pp-cli profile-merge
    — Merge a given related profile into a profile with the given profile ID. The profile provided under
    relationships
    ...
profile-subscription-bulk-create-jobs — Manage profile subscription bulk create jobs
  • klaviyo-pp-cli profile-subscription-bulk-create-jobs
    — Subscribe one or more profiles to email marketing, SMS marketing, WhatsApp, or push. If the provided list has double...
profile-subscription-bulk-delete-jobs — Manage profile subscription bulk delete jobs
  • klaviyo-pp-cli profile-subscription-bulk-delete-jobs
    — > 🚧 > > Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership...
profile-suppression-bulk-create-jobs — Manage profile suppression bulk create jobs
  • klaviyo-pp-cli profile-suppression-bulk-create-jobs bulk-suppress-profiles
    — 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 get-bulk-suppress-profiles-job
    — Get the bulk suppress profiles job with the given job ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    ...
  • klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-jobs
    — Get the status of all bulk profile suppression jobs.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    ...
profile-suppression-bulk-delete-jobs — Manage profile suppression bulk delete jobs
  • klaviyo-pp-cli profile-suppression-bulk-delete-jobs bulk-unsuppress-profiles
    — 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 get-bulk-unsuppress-profiles-job
    — Get the bulk unsuppress profiles job with the given job ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:...
  • klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-jobs
    — Get all bulk unsuppress profiles jobs.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    Scopes:...
profiles — profiles
  • klaviyo-pp-cli profiles create
    — Create a new profile. Use the
    additional-fields
    parameter to include subscriptions and predictive analytics data...
  • klaviyo-pp-cli profiles get
    — Get all profiles in an account. Profiles can be sorted by the following fields in ascending and descending order:...
  • klaviyo-pp-cli profiles get-id
    — Get the profile with the given profile ID. Use the
    additional-fields
    parameter to include subscriptions and...
  • klaviyo-pp-cli profiles update
    — Update the profile with the given profile ID. Use the
    additional-fields
    parameter to include subscriptions and...
push-tokens — Manage push tokens
  • klaviyo-pp-cli push-tokens create
    — 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 delete
    — Delete a specific push token based on its ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:...
  • klaviyo-pp-cli push-tokens get
    — Return push tokens associated with company.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:...
  • klaviyo-pp-cli push-tokens get-pushtokens
    — Return a specific push token based on its ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:...
reviews — reviews
  • klaviyo-pp-cli reviews get
    — Get all reviews.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:
    reviews:read
  • klaviyo-pp-cli reviews get-id
    — Get the review with the given ID.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:
    reviews:read
  • klaviyo-pp-cli reviews update
    — Update a review.<br><br>Rate limits:<br>Burst:
    10/s
    <br>Steady:
    150/m
    Scopes:
    reviews:write
segment-series-reports — Manage segment series reports
  • klaviyo-pp-cli segment-series-reports
    — Returns the requested segment analytics series data.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:...
segment-values-reports — Manage segment values reports
  • klaviyo-pp-cli segment-values-reports
    — Returns the requested segment analytics values data.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:...
segments — segments
  • klaviyo-pp-cli segments create
    — Create a segment.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    <br>Daily:
    100/d
    Scopes:
    segments:write
  • klaviyo-pp-cli segments delete
    — Delete a segment with the given segment ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:...
  • klaviyo-pp-cli segments get
    — Get all segments in an account. Filter to request a subset of all segments. Segments can be filtered by
    name
    ,...
  • klaviyo-pp-cli segments get-id
    — Get a segment with the given segment ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    <br><br>Rate...
  • klaviyo-pp-cli segments update
    — Update a segment with the given segment ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    <br>Daily:...
tag-groups — Manage tag groups
  • klaviyo-pp-cli tag-groups create
    — Create a tag group. An account cannot have more than 50 unique tag groups. If
    exclusive
    is not specified...
  • klaviyo-pp-cli tag-groups delete
    — 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 get
    — List all tag groups in an account. Every account has one default tag group. Tag groups can be filtered by
    name
    ,...
  • klaviyo-pp-cli tag-groups get-taggroups
    — Retrieve the tag group with the given tag group ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    ...
  • klaviyo-pp-cli tag-groups update
    — Update the tag group with the given tag group ID. Only a tag group's
    name
    can be changed. A tag group's...
tags — tags
  • klaviyo-pp-cli tags create
    — 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 delete
    — Delete the tag with the given tag ID. Any associations between the tag and other resources will also be...
  • klaviyo-pp-cli tags get
    — List all tags in an account. Tags can be filtered by
    name
    , and sorted by
    name
    or
    id
    in ascending or descending...
  • klaviyo-pp-cli tags get-id
    — Retrieve the tag with the given tag ID.<br><br>Rate limits:<br>Burst:
    3/s
    <br>Steady:
    60/m
    Scopes:
    tags:read
  • klaviyo-pp-cli tags update
    — 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...
template-clone — Manage template clone
  • klaviyo-pp-cli 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...
template-render — Manage template render
  • klaviyo-pp-cli template-render
    — Render a template with the given template ID and context attribute. Returns the AMP, HTML, and plain text versions...
template-universal-content — Manage template universal content
  • klaviyo-pp-cli template-universal-content create-universal-content
    — Create universal content. Currently supported block types are:
    button
    ,
    drop_shadow
    ,
    horizontal_rule
    ,
    html
    ,...
  • klaviyo-pp-cli template-universal-content delete-universal-content
    — Delete the universal content with the given ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    ...
  • klaviyo-pp-cli template-universal-content get-all-universal-content
    — Get all universal content in an account.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    Scopes:...
  • klaviyo-pp-cli template-universal-content get-universal-content
    — Get the universal content with the given ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    Scopes:...
  • klaviyo-pp-cli template-universal-content update-universal-content
    — Update universal content. The
    definition
    field can only be updated on the following block types at this time:...
templates — templates
  • klaviyo-pp-cli templates create
    — 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 delete
    — Delete a template with the given template ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    Scopes:...
  • klaviyo-pp-cli templates get
    — Get all templates in an account. Use
    additional-fields[template]=definition
    to include the full template...
  • klaviyo-pp-cli templates get-id
    — Get a template with the given template ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    Scopes:...
  • klaviyo-pp-cli templates update
    — Update a template with the given template ID.<br><br>Rate limits:<br>Burst:
    75/s
    <br>Steady:
    750/m
    Scopes:...
tracking-settings — tracking settings
  • klaviyo-pp-cli tracking-settings get
    — 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-trackingsettings
    — Get the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found...
  • klaviyo-pp-cli tracking-settings update
    — Update the UTM tracking setting with the given account ID. More information about UTM tracking settings can be found...
web-feeds — web feeds
  • klaviyo-pp-cli web-feeds create
    — Create a web feed.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:
    web-feeds:write
  • klaviyo-pp-cli web-feeds delete
    — Delete the web feed with the given ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:...
  • klaviyo-pp-cli web-feeds get
    — Get all web feeds for an account.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:
    web-feeds:read
  • klaviyo-pp-cli web-feeds get-webfeeds
    — Get the web feed with the given ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:
    web-feeds:read
  • klaviyo-pp-cli web-feeds update
    — Update the web feed with the given ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:...
webhook-topics — Manage webhook topics
  • klaviyo-pp-cli webhook-topics get
    — Get all webhook topics in a Klaviyo account.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:...
  • klaviyo-pp-cli webhook-topics get-webhooktopics
    — Get the webhook topic with the given ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:...
webhooks — webhooks
  • klaviyo-pp-cli webhooks create
    — Create a new Webhook<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:
    webhooks:write
  • klaviyo-pp-cli webhooks delete
    — Delete a webhook with the given ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:
    webhooks:write
  • klaviyo-pp-cli webhooks get
    — Get all webhooks in an account.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:
    webhooks:read
  • klaviyo-pp-cli webhooks get-id
    — Get the webhook with the given ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:
    webhooks:read
  • klaviyo-pp-cli webhooks update
    — Update the webhook with the given ID.<br><br>Rate limits:<br>Burst:
    1/s
    <br>Steady:
    15/m
    Scopes:...
accounts — 账户管理
  • klaviyo-pp-cli accounts get
    — 获取与给定私有API密钥关联的账户。返回结果为包含1个账户对象的数组....
  • klaviyo-pp-cli accounts get-id
    — 通过账户ID获取单个账户对象。仅可通过与私有API密钥关联的账户进行请求...
back-in-stock-subscriptions — 补货通知订阅管理
  • klaviyo-pp-cli back-in-stock-subscriptions
    — 订阅补货通知。详情请查看[我们的补货通知API...
campaign-clone — 营销活动克隆管理
  • klaviyo-pp-cli campaign-clone
    — 克隆现有营销活动,返回一个基于原活动的新活动,包含新的ID和名称。<br><br>*调用频率限制...
campaign-message-assign-template — 营销活动消息模板分配管理
  • klaviyo-pp-cli campaign-message-assign-template
    — 创建模板的不可复用版本,并将其分配给消息。<br><br>调用频率限制:<br>突发:...
campaign-messages — 营销活动消息管理
  • klaviyo-pp-cli campaign-messages get
    — 根据必填ID返回特定消息。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    ...
  • klaviyo-pp-cli campaign-messages update
    — 更新营销活动消息<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:
    campaigns:write
campaign-recipient-estimation-jobs — 营销活动收件人估算任务管理
  • klaviyo-pp-cli campaign-recipient-estimation-jobs get
    — 获取通过“创建营销活动收件人估算任务”触发的任务状态...
  • klaviyo-pp-cli campaign-recipient-estimation-jobs refresh-campaign-recipient-estimation
    — 触发异步任务更新指定营销活动ID的预估收件人数。使用“获取...
campaign-recipient-estimations — 营销活动收件人估算管理
  • klaviyo-pp-cli campaign-recipient-estimations <id>
    — 根据提供的营销活动ID获取预估收件人数。可通过使用...刷新该数值
campaign-send-jobs — 营销活动发送任务管理
  • klaviyo-pp-cli campaign-send-jobs cancel-campaign-send
    — 永久取消营销活动,将状态设置为CANCELED,或撤销营销活动,将状态恢复为...
  • klaviyo-pp-cli campaign-send-jobs get
    — 获取营销活动发送任务<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:
    campaigns:read
  • klaviyo-pp-cli campaign-send-jobs send-campaign
    — 触发营销活动异步发送<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:...
campaign-values-reports — 营销活动数值报告管理
  • klaviyo-pp-cli campaign-values-reports
    — 返回请求的营销活动分析数值数据<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:...
campaigns — 营销活动管理
  • klaviyo-pp-cli campaigns create
    — 根据一组参数创建营销活动并返回该活动。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:...
  • klaviyo-pp-cli campaigns delete
    — 根据给定营销活动ID删除营销活动。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:...
  • klaviyo-pp-cli campaigns get
    — 根据筛选条件返回部分或全部营销活动。列出营销活动时必须提供渠道筛选条件。请提供...
  • klaviyo-pp-cli campaigns get-id
    — 根据必填ID返回特定营销活动。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    ...
  • klaviyo-pp-cli campaigns update
    — 根据给定营销活动ID更新营销活动。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:...
catalog-categories — 商品分类管理
  • klaviyo-pp-cli catalog-categories create-catalog-category
    — 创建新的商品分类。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    权限范围:
    catalogs:write
  • klaviyo-pp-cli catalog-categories delete-catalog-category
    — 根据给定分类ID删除商品分类。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    ...
  • klaviyo-pp-cli catalog-categories get
    — 获取账户内所有商品分类。商品分类可按以下字段进行升序或降序排序...
  • klaviyo-pp-cli catalog-categories get-catalog-category
    — 根据给定分类ID获取商品分类。<br><br>调用频率限制:<br>突发:
    350/s
    <br>稳定:
    3500/m
    ...
  • klaviyo-pp-cli catalog-categories update-catalog-category
    — 根据给定分类ID更新商品分类。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    ...
catalog-category-bulk-create-jobs — 商品分类批量创建任务管理
  • klaviyo-pp-cli catalog-category-bulk-create-jobs bulk-create-catalog-categories
    — 创建商品分类批量创建任务,批量创建商品分类。每次请求最多支持100个商品...
  • klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-job
    — 根据给定任务ID获取商品分类批量创建任务。可提供
    include
    参数获取...
  • klaviyo-pp-cli catalog-category-bulk-create-jobs get-bulk-create-categories-jobs
    — 获取所有商品分类批量创建任务。每次请求最多返回100个任务。<br><br>*调用频率...
catalog-category-bulk-delete-jobs — 商品分类批量删除任务管理
  • klaviyo-pp-cli catalog-category-bulk-delete-jobs bulk-delete-catalog-categories
    — 创建商品分类批量删除任务,批量删除商品分类。每次请求最多支持100个商品...
  • klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-job
    — 根据给定任务ID获取商品分类批量删除任务。<br><br>调用频率限制:<br>突发:
    350/s
    <br>稳定:...
  • klaviyo-pp-cli catalog-category-bulk-delete-jobs get-bulk-delete-categories-jobs
    — 获取所有商品分类批量删除任务。每次请求最多返回100个任务。<br><br>*调用频率...
catalog-category-bulk-update-jobs — 商品分类批量更新任务管理
  • klaviyo-pp-cli catalog-category-bulk-update-jobs bulk-update-catalog-categories
    — 创建商品分类批量更新任务,批量更新商品分类。每次请求最多支持100个商品...
  • klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-job
    — 根据给定任务ID获取商品分类批量更新任务。可提供
    include
    参数获取...
  • klaviyo-pp-cli catalog-category-bulk-update-jobs get-bulk-update-categories-jobs
    — 获取所有商品分类批量更新任务。每次请求最多返回100个任务。<br><br>*调用频率...
catalog-item-bulk-create-jobs — 商品项批量创建任务管理
  • klaviyo-pp-cli catalog-item-bulk-create-jobs bulk-create-catalog-items
    — 创建商品项批量创建任务,批量创建商品项。每次请求最多支持100个商品项...
  • klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-job
    — 根据给定任务ID获取商品项批量创建任务。可提供
    include
    参数获取...
  • klaviyo-pp-cli catalog-item-bulk-create-jobs get-bulk-create-catalog-items-jobs
    — 获取所有商品项批量创建任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
catalog-item-bulk-delete-jobs — 商品项批量删除任务管理
  • klaviyo-pp-cli catalog-item-bulk-delete-jobs bulk-delete-catalog-items
    — 创建商品项批量删除任务,批量删除商品项。每次请求最多支持100个商品项...
  • klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-job
    — 根据给定任务ID获取商品项批量删除任务。<br><br>调用频率限制:<br>突发:
    350/s
    <br>稳定:...
  • klaviyo-pp-cli catalog-item-bulk-delete-jobs get-bulk-delete-catalog-items-jobs
    — 获取所有商品项批量删除任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
catalog-item-bulk-update-jobs — 商品项批量更新任务管理
  • klaviyo-pp-cli catalog-item-bulk-update-jobs bulk-update-catalog-items
    — 创建商品项批量更新任务,批量更新商品项。每次请求最多支持100个商品项...
  • klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-job
    — 根据给定任务ID获取商品项批量更新任务。可提供
    include
    参数获取...
  • klaviyo-pp-cli catalog-item-bulk-update-jobs get-bulk-update-catalog-items-jobs
    — 获取所有商品项批量更新任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
catalog-items — 商品项管理
  • klaviyo-pp-cli catalog-items create
    — 创建新的商品项。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    权限范围:
    catalogs:write
  • klaviyo-pp-cli catalog-items delete
    — 根据给定商品项ID删除商品项。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    权限范围:...
  • klaviyo-pp-cli catalog-items get
    — 获取账户内所有商品项。商品项可按以下字段进行升序或降序排序...
  • klaviyo-pp-cli catalog-items get-catalogitems
    — 根据给定商品项ID获取特定商品项。<br><br>调用频率限制:<br>突发:
    350/s
    <br>稳定:
    3500/m
    ...
  • klaviyo-pp-cli catalog-items update
    — 根据给定商品项ID更新商品项。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    权限范围:...
catalog-variant-bulk-create-jobs — 商品变体批量创建任务管理
  • klaviyo-pp-cli catalog-variant-bulk-create-jobs bulk-create-catalog-variants
    — 创建商品变体批量创建任务,批量创建商品变体。每次请求最多支持100个商品变体...
  • klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-job
    — 根据给定任务ID获取商品变体批量创建任务。可提供
    include
    参数获取...
  • klaviyo-pp-cli catalog-variant-bulk-create-jobs get-bulk-create-variants-jobs
    — 获取所有商品变体批量创建任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
catalog-variant-bulk-delete-jobs — 商品变体批量删除任务管理
  • klaviyo-pp-cli catalog-variant-bulk-delete-jobs bulk-delete-catalog-variants
    — 创建商品变体批量删除任务,批量删除商品变体。每次请求最多支持100个商品变体...
  • klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-job
    — 根据给定任务ID获取商品变体批量删除任务。<br><br>调用频率限制:<br>突发:
    350/s
    <br>稳定:...
  • klaviyo-pp-cli catalog-variant-bulk-delete-jobs get-bulk-delete-variants-jobs
    — 获取所有商品变体批量删除任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
catalog-variant-bulk-update-jobs — 商品变体批量更新任务管理
  • klaviyo-pp-cli catalog-variant-bulk-update-jobs bulk-update-catalog-variants
    — 创建商品变体批量更新任务,批量更新商品变体。每次请求最多支持100个商品变体...
  • klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-job
    — 根据给定任务ID获取商品变体批量更新任务。可提供
    include
    参数获取...
  • klaviyo-pp-cli catalog-variant-bulk-update-jobs get-bulk-update-variants-jobs
    — 获取所有商品变体批量更新任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
catalog-variants — 商品变体管理
  • klaviyo-pp-cli catalog-variants create
    — 为关联商品项创建新变体。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    ...
  • klaviyo-pp-cli catalog-variants delete
    — 根据给定变体ID删除商品项变体。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    ...
  • klaviyo-pp-cli catalog-variants get
    — 获取账户内所有变体。变体可按以下字段进行升序或降序排序...
  • klaviyo-pp-cli catalog-variants get-catalogvariants
    — 根据给定变体ID获取商品项变体。<br><br>调用频率限制:<br>突发:
    350/s
    <br>稳定:
    3500/m
    ...
  • klaviyo-pp-cli catalog-variants update
    — 根据给定变体ID更新商品项变体。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    ...
client — 客户端操作
  • klaviyo-pp-cli client bulk-create-events
    — 创建新事件以追踪用户档案的活动。该接口专门设计用于从...调用
  • klaviyo-pp-cli client create-back-in-stock-subscription
    — 订阅补货通知。详情请查看[我们的补货通知API...
  • klaviyo-pp-cli client create-event
    — 创建新事件以追踪用户档案的活动。该接口专门设计用于从...调用
  • klaviyo-pp-cli client create-profile
    — 创建或更新用户档案属性,无需关联追踪事件。该接口专门...
  • klaviyo-pp-cli client create-push-token
    — 创建或更新推送令牌。该接口专门设计用于从我们的移动SDK调用...
  • klaviyo-pp-cli client create-review
    — 根据给定ID创建评论。该接口仅适用于客户端环境。<br><br>*调用频率...
  • klaviyo-pp-cli client create-subscription
    — 根据提供的
    email
    和...创建邮件和/或SMS渠道的订阅及同意记录
  • klaviyo-pp-cli client get-geofences
    — 获取账户内所有地理围栏。返回指定公司的所有地理围栏分页列表。这是正式版...
  • klaviyo-pp-cli client get-review-values-reports
    — 获取账户内所有评论数值报告。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
  • klaviyo-pp-cli client get-reviews
    — 获取所有评论。该接口仅适用于客户端环境,服务端使用请参考...
  • klaviyo-pp-cli client unregister-push-token
    — 注销推送令牌。该接口专门设计用于从我们的移动SDK调用...
conversation-messages — 对话消息管理
  • klaviyo-pp-cli conversation-messages
    — 向对话发送出站消息。需要OAuth认证和账户级启用。如需请求...
coupon-code-bulk-create-jobs — 优惠券代码批量创建任务管理
  • klaviyo-pp-cli coupon-code-bulk-create-jobs bulk-create-coupon-codes
    — 创建优惠券代码批量创建任务,批量生成优惠券代码。每个任务最多支持的优惠券代码数量为...
  • klaviyo-pp-cli coupon-code-bulk-create-jobs get-bulk-create-coupon-code-jobs
    — 获取所有优惠券代码批量创建任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
  • klaviyo-pp-cli coupon-code-bulk-create-jobs get-bulk-create-coupon-codes-job
    — 根据给定任务ID获取优惠券代码批量创建任务。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    ...
coupon-codes — 优惠券代码管理
  • klaviyo-pp-cli coupon-codes create
    — 为给定优惠券同步创建优惠券代码。<br><br>调用频率限制:<br>突发:
    350/s
    <br>稳定:...
  • klaviyo-pp-cli coupon-codes delete
    — 根据给定标识符同步删除优惠券代码。如果用户档案已分配该优惠券...
  • klaviyo-pp-cli coupon-codes get
    — 获取与优惠券/多个优惠券或用户档案/多个用户档案关联的优惠券代码列表。需提供优惠券/多个优惠券或...
  • klaviyo-pp-cli coupon-codes get-couponcodes
    — 根据给定标识符返回优惠券代码。<br><br>调用频率限制:<br>突发:
    350/s
    <br>稳定:
    3500/m
    ...
  • klaviyo-pp-cli coupon-codes update
    — 根据给定标识符同步更新优惠券代码。我们允许更新'status'和...
coupons — 优惠券管理
  • klaviyo-pp-cli coupons create
    — 创建新优惠券。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    coupons:write
  • klaviyo-pp-cli coupons delete
    — 根据给定优惠券ID删除优惠券。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:...
  • klaviyo-pp-cli coupons get
    — 获取账户内所有优惠券。如需了解更多,请查看我们的[优惠券API...
  • klaviyo-pp-cli coupons get-id
    — 根据给定优惠券ID获取特定优惠券。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    ...
  • klaviyo-pp-cli coupons update
    调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    coupons:write
custom-metrics — 自定义指标管理
  • klaviyo-pp-cli custom-metrics create
    — 创建新的自定义指标。自定义指标对象必须包含
    name
    definition
    <br><br>*调用频率...
  • klaviyo-pp-cli custom-metrics delete
    — 根据给定自定义指标ID删除自定义指标。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    ...
  • klaviyo-pp-cli custom-metrics get
    — 获取账户内所有自定义指标。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    metrics:read
  • klaviyo-pp-cli custom-metrics get-custommetrics
    — 根据给定自定义指标ID获取自定义指标。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    ...
  • klaviyo-pp-cli custom-metrics update
    — 根据给定自定义指标ID更新自定义指标。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:...
data-privacy-deletion-jobs — 数据隐私删除任务管理
  • klaviyo-pp-cli data-privacy-deletion-jobs
    — 请求删除与以下标识符对应的用户档案:
    email
    phone_number
    或...
data-source-record-bulk-create-jobs — 数据源记录批量创建任务管理
  • klaviyo-pp-cli data-source-record-bulk-create-jobs
    — 创建批量数据源记录导入任务,批量创建记录。每次请求最多支持500条记录。该...
data-source-record-create-jobs — 数据源记录创建任务管理
  • klaviyo-pp-cli data-source-record-create-jobs
    — 创建数据源记录导入任务,创建单条记录。每条记录的最大允许负载大小为...
data-sources — 数据源管理
  • klaviyo-pp-cli data-sources create
    — 在账户内创建新数据源<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:...
  • klaviyo-pp-cli data-sources delete
    — 删除账户内的数据源。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:...
  • klaviyo-pp-cli data-sources get
    — 获取账户内所有数据源。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:...
  • klaviyo-pp-cli data-sources get-datasources
    — 获取账户内的数据源。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    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
    [自定义...
  • klaviyo-pp-cli events get-id
    — 根据给定事件ID获取事件。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:...
flow-actions — 自动化流程操作管理
  • klaviyo-pp-cli flow-actions get
    — 根据给定流程操作ID获取自动化流程中的操作。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    ...
  • klaviyo-pp-cli flow-actions update
    — 更新自动化流程操作。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    flows:write
flow-messages — 自动化流程消息管理
  • klaviyo-pp-cli flow-messages <id>
    — 根据给定流程消息ID获取自动化流程中的消息。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:...
flow-series-reports — 自动化流程系列报告管理
  • klaviyo-pp-cli flow-series-reports
    — 返回请求的自动化流程分析系列数据<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    2/m
    <br>每日:...
flow-values-reports — 自动化流程数值报告管理
  • klaviyo-pp-cli flow-values-reports
    — 返回请求的自动化流程分析数值数据<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    2/m
    <br>每日:...
flows — 自动化流程管理
  • klaviyo-pp-cli flows create
    — 使用编码的流程定义创建新自动化流程。流程定义中的新对象(如操作)将...
  • klaviyo-pp-cli flows delete
    — 根据给定流程ID删除自动化流程。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    flows:write
  • klaviyo-pp-cli flows get
    — 获取账户内所有自动化流程。每次请求最多返回50个流程,可通过基于游标...分页
  • klaviyo-pp-cli flows get-id
    — 根据给定流程ID获取自动化流程。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    flows:read
  • klaviyo-pp-cli flows update
    — 根据给定流程ID更新自动化流程的状态及其中的所有操作。<br><br>调用频率限制:<br>突发:...
form-series-reports — 表单系列报告管理
  • klaviyo-pp-cli form-series-reports
    — 返回请求的表单分析系列数据。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    2/m
    <br>每日:...
form-values-reports — 表单数值报告管理
  • klaviyo-pp-cli form-values-reports
    — 返回请求的表单分析数值数据。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    2/m
    <br>每日:...
form-versions — 表单版本管理
  • klaviyo-pp-cli form-versions <id>
    — 根据给定ID获取表单版本。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    forms:read
forms — 表单管理
  • klaviyo-pp-cli forms create
    — 创建新表单。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    forms:write
  • klaviyo-pp-cli forms delete
    — 删除给定表单。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    forms:write
  • klaviyo-pp-cli forms get
    — 获取账户内所有表单。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    forms:read
  • klaviyo-pp-cli forms get-id
    — 根据给定ID获取表单。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    forms:read
image-upload — 图片上传管理
  • klaviyo-pp-cli image-upload
    — 从文件上传图片。如果要从现有URL或数据URI导入图片,请使用“从URL上传图片...
images — 图片管理
  • klaviyo-pp-cli images get
    — 获取账户内所有图片。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:
    images:read
  • klaviyo-pp-cli images get-id
    — 根据给定图片ID获取图片。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:...
  • klaviyo-pp-cli images update
    — 根据给定图片ID更新图片。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:...
  • klaviyo-pp-cli images upload-from-url
    — 从URL或数据URI导入图片。如果要从文件上传图片,请使用“从文件上传图片...
lists — 用户列表管理
  • klaviyo-pp-cli lists create
    — 创建新用户列表。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    <br>每日:
    150/d
    权限范围:
    lists:write
  • klaviyo-pp-cli lists delete
    — 根据给定列表ID删除用户列表。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:...
  • klaviyo-pp-cli lists get
    — 获取账户内所有用户列表。可筛选请求部分用户列表。用户列表可按
    id
    name
    、...筛选
  • klaviyo-pp-cli lists get-id
    — 根据给定列表ID获取用户列表。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    <br><br>调用频率限制在...
  • klaviyo-pp-cli lists update
    — 根据给定列表ID更新用户列表名称。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    ...
mapped-metrics — 映射指标管理
  • klaviyo-pp-cli mapped-metrics get
    — 获取账户内所有映射指标。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    metrics:read
  • klaviyo-pp-cli mapped-metrics get-mappedmetrics
    — 根据给定ID获取映射指标。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:...
  • klaviyo-pp-cli mapped-metrics update
    — 根据给定ID更新映射指标。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    <br>每日:
    30/d
    ...
metric-aggregates — 指标聚合管理
  • klaviyo-pp-cli metric-aggregates
    — 查询并聚合与指标关联的事件数据,包括Klaviyo原生指标、集成特定...
metric-properties — 指标属性管理
  • klaviyo-pp-cli metric-properties <id>
    — 根据给定指标属性ID获取指标属性。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    ...
metrics — 指标管理
  • klaviyo-pp-cli metrics get
    — 获取账户内所有指标。请求可按以下字段筛选:集成
    name
    、集成...
  • klaviyo-pp-cli metrics get-id
    — 根据给定指标ID获取指标。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:...
profile-bulk-import-jobs — 用户档案批量导入任务管理
  • klaviyo-pp-cli profile-bulk-import-jobs bulk-import-profiles
    — 创建用户档案批量导入任务,批量创建或更新用户档案。每次请求最多支持10000个用户档案....
  • klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-job
    — 根据给定任务ID获取用户档案批量导入任务。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    ...
  • klaviyo-pp-cli profile-bulk-import-jobs get-bulk-import-profiles-jobs
    — 获取所有用户档案批量导入任务。每次请求最多返回100个任务。<br><br>调用频率限制:<br>突发:...
profile-import — 用户档案导入管理
  • klaviyo-pp-cli profile-import
    — 根据一组用户档案属性(可选包含ID)创建或更新用户档案。如果创建了新用户档案,返回201...
profile-merge — 用户档案合并管理
  • klaviyo-pp-cli profile-merge
    — 将给定关联用户档案合并到指定ID的用户档案中。
    relationships
    下提供的用户档案...
profile-subscription-bulk-create-jobs — 用户档案订阅批量创建任务管理
  • klaviyo-pp-cli profile-subscription-bulk-create-jobs
    — 订阅一个或多个用户档案接收邮件营销、SMS营销、WhatsApp或推送通知。如果提供的列表包含重复...
profile-subscription-bulk-delete-jobs — 用户档案订阅批量删除任务管理
  • klaviyo-pp-cli profile-subscription-bulk-delete-jobs
    — > 🚧 > > 不在指定列表中的用户档案将被全局取消订阅。请始终验证用户档案列表归属...
profile-suppression-bulk-create-jobs — 用户档案批量抑制任务管理
  • klaviyo-pp-cli profile-suppression-bulk-create-jobs bulk-suppress-profiles
    — 通过邮箱地址手动抑制用户档案,或指定细分/列表ID抑制该细分/列表的所有当前成员...
  • klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-job
    — 根据给定任务ID获取用户档案批量抑制任务。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    ...
  • klaviyo-pp-cli profile-suppression-bulk-create-jobs get-bulk-suppress-profiles-jobs
    — 获取所有用户档案批量抑制任务的状态。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    ...
profile-suppression-bulk-delete-jobs — 用户档案批量取消抑制任务管理
  • klaviyo-pp-cli profile-suppression-bulk-delete-jobs bulk-unsuppress-profiles
    — 通过邮箱地址手动取消抑制用户档案,或指定细分/列表ID取消抑制该细分/列表的所有当前成员...
  • klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-job
    — 根据给定任务ID获取用户档案批量取消抑制任务。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:...
  • klaviyo-pp-cli profile-suppression-bulk-delete-jobs get-bulk-unsuppress-profiles-jobs
    — 获取所有用户档案批量取消抑制任务。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    权限范围:...
profiles — 用户档案管理
  • klaviyo-pp-cli profiles create
    — 创建新用户档案。使用
    additional-fields
    参数可包含订阅和预测分析数据...
  • klaviyo-pp-cli profiles get
    — 获取账户内所有用户档案。用户档案可按以下字段进行升序或降序排序...
  • klaviyo-pp-cli profiles get-id
    — 根据给定用户档案ID获取用户档案。使用
    additional-fields
    参数可包含订阅和...
  • klaviyo-pp-cli profiles update
    — 根据给定用户档案ID更新用户档案。使用
    additional-fields
    参数可包含订阅和...
push-tokens — 推送令牌管理
  • klaviyo-pp-cli push-tokens create
    — 创建或更新推送令牌。该接口可用于将推送令牌从其他平台迁移到Klaviyo....
  • klaviyo-pp-cli push-tokens delete
    — 根据ID删除特定推送令牌。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:...
  • klaviyo-pp-cli push-tokens get
    — 返回与公司关联的推送令牌。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:...
  • klaviyo-pp-cli push-tokens get-pushtokens
    — 根据ID返回特定推送令牌。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:...
reviews — 评论管理
  • klaviyo-pp-cli reviews get
    — 获取所有评论。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:
    reviews:read
  • klaviyo-pp-cli reviews get-id
    — 根据给定ID获取评论。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:
    reviews:read
  • klaviyo-pp-cli reviews update
    — 更新评论。<br><br>调用频率限制:<br>突发:
    10/s
    <br>稳定:
    150/m
    权限范围:
    reviews:write
segment-series-reports — 用户细分系列报告管理
  • klaviyo-pp-cli segment-series-reports
    — 返回请求的用户细分分析系列数据。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:...
segment-values-reports — 用户细分数值报告管理
  • klaviyo-pp-cli segment-values-reports
    — 返回请求的用户细分分析数值数据。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:...
segments — 用户细分管理
  • klaviyo-pp-cli segments create
    — 创建用户细分。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    <br>每日:
    100/d
    权限范围:
    segments:write
  • klaviyo-pp-cli segments delete
    — 根据给定细分ID删除用户细分。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:...
  • klaviyo-pp-cli segments get
    — 获取账户内所有用户细分。可筛选请求部分用户细分。用户细分可按
    name
    、...筛选
  • klaviyo-pp-cli segments get-id
    — 根据给定细分ID获取用户细分。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    <br><br>调用频率...
  • klaviyo-pp-cli segments update
    — 根据给定细分ID更新用户细分。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    <br>每日:...
tag-groups — 标签组管理
  • klaviyo-pp-cli tag-groups create
    — 创建标签组。一个账户最多可拥有50个唯一标签组。如果未指定
    exclusive
    ...
  • klaviyo-pp-cli tag-groups delete
    — 根据给定标签组ID删除标签组。该标签组内的所有标签以及标签与其他资源的关联将...
  • klaviyo-pp-cli tag-groups get
    — 列出账户内所有标签组。每个账户都有一个默认标签组。标签组可按
    name
    、...筛选
  • klaviyo-pp-cli tag-groups get-taggroups
    — 根据给定标签组ID获取标签组。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    ...
  • klaviyo-pp-cli tag-groups update
    — 根据给定标签组ID更新标签组。仅可修改标签组的
    name
    。标签组的...
tags — 标签管理
  • klaviyo-pp-cli tags create
    — 创建标签。一个账户最多可拥有500个唯一标签。标签属于单个标签组。如果...
  • klaviyo-pp-cli tags delete
    — 根据给定标签ID删除标签。标签与其他资源的所有关联也将...
  • klaviyo-pp-cli tags get
    — 列出账户内所有标签。标签可按
    name
    筛选,并按
    name
    id
    进行升序或降序排序...
  • klaviyo-pp-cli tags get-id
    — 根据给定标签ID获取标签。<br><br>调用频率限制:<br>突发:
    3/s
    <br>稳定:
    60/m
    权限范围:
    tags:read
  • klaviyo-pp-cli tags update
    — 根据给定标签ID更新标签。仅可修改标签的
    name
    。标签无法从一个标签组...
template-clone — 模板克隆管理
  • klaviyo-pp-cli template-clone
    — 根据给定模板ID创建模板克隆。如果账户内已有1000个或更多模板,克隆...
template-render — 模板渲染管理
  • klaviyo-pp-cli template-render
    — 根据给定模板ID和上下文属性渲染模板。返回AMP、HTML和纯文本版本...
template-universal-content — 模板通用内容管理
  • klaviyo-pp-cli template-universal-content create-universal-content
    — 创建通用内容。目前支持的块类型包括:
    button
    drop_shadow
    horizontal_rule
    html
    、...
  • klaviyo-pp-cli template-universal-content delete-universal-content
    — 根据给定ID删除通用内容。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    ...
  • klaviyo-pp-cli template-universal-content get-all-universal-content
    — 获取账户内所有通用内容。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    权限范围:...
  • klaviyo-pp-cli template-universal-content get-universal-content
    — 根据给定ID获取通用内容。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    权限范围:...
  • klaviyo-pp-cli template-universal-content update-universal-content
    — 更新通用内容。目前仅可更新以下块类型的
    definition
    字段:...
templates — 模板管理
  • klaviyo-pp-cli templates create
    — 创建新的HTML或拖拽式模板。如果账户内已有1000个或更多模板,创建将失败...
  • klaviyo-pp-cli templates delete
    — 根据给定模板ID删除模板。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    权限范围:...
  • klaviyo-pp-cli templates get
    — 获取账户内所有模板。使用
    additional-fields[template]=definition
    可包含完整模板...
  • klaviyo-pp-cli templates get-id
    — 根据给定模板ID获取模板。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    权限范围:...
  • klaviyo-pp-cli templates update
    — 根据给定模板ID更新模板。<br><br>调用频率限制:<br>突发:
    75/s
    <br>稳定:
    750/m
    权限范围:...
tracking-settings — 追踪设置管理
  • klaviyo-pp-cli tracking-settings get
    — 获取账户内所有UTM追踪设置。返回包含单个追踪设置的数组。更多关于...的信息
  • klaviyo-pp-cli tracking-settings get-trackingsettings
    — 根据给定账户ID获取UTM追踪设置。更多关于UTM追踪设置的信息可查看...
  • klaviyo-pp-cli tracking-settings update
    — 根据给定账户ID更新UTM追踪设置。更多关于UTM追踪设置的信息可查看...
web-feeds — 网页源管理
  • klaviyo-pp-cli web-feeds create
    — 创建网页源。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:
    web-feeds:write
  • klaviyo-pp-cli web-feeds delete
    — 根据给定ID删除网页源。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:...
  • klaviyo-pp-cli web-feeds get
    — 获取账户内所有网页源。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:
    web-feeds:read
  • klaviyo-pp-cli web-feeds get-webfeeds
    — 根据给定ID获取网页源。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:
    web-feeds:read
  • klaviyo-pp-cli web-feeds update
    — 根据给定ID更新网页源。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:...
webhook-topics — Webhook主题管理
  • klaviyo-pp-cli webhook-topics get
    — 获取Klaviyo账户内所有Webhook主题。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:...
  • klaviyo-pp-cli webhook-topics get-webhooktopics
    — 根据给定ID获取Webhook主题。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:...
webhooks — Webhook管理
  • klaviyo-pp-cli webhooks create
    — 创建新Webhook<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:
    webhooks:write
  • klaviyo-pp-cli webhooks delete
    — 根据给定ID删除Webhook。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:
    webhooks:write
  • klaviyo-pp-cli webhooks get
    — 获取账户内所有Webhook。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:
    webhooks:read
  • klaviyo-pp-cli webhooks get-id
    — 根据给定ID获取Webhook。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    15/m
    权限范围:
    webhooks:read
  • klaviyo-pp-cli webhooks update
    — 根据给定ID更新Webhook。<br><br>调用频率限制:<br>突发:
    1/s
    <br>稳定:
    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>"
which
resolves a natural-language capability query to the best matching command from this CLI's curated feature index. Exit code
0
means at least one match; exit code
2
means no confident match — fall back to
--help
or use a narrower query.
当你知道要执行的操作但不知道对应的命令时,可直接询问CLI:
bash
klaviyo-pp-cli which "<用自己的话描述功能>"
which
命令会将自然语言的功能查询解析为CLI精选功能索引中最匹配的命令。退出码
0
表示至少有一个匹配项;退出码
2
表示没有匹配度高的命令 — 可改用
--help
或更精准的查询。

Recipes

使用示例

Inspect a profile compactly

简洁查看用户档案

bash
klaviyo-pp-cli profiles list --limit 1 --json --select data.id,data.email,data.first_name
Fetch 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 --json
Review 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
klaviyo-pp-cli doctor
to verify setup.
将KLAVIYO_API_KEY设置为Klaviyo私有API密钥。请求将发送Authorization: Klaviyo-API-Key <token>,并使用生成的OpenAPI规范固定的版本。
运行
klaviyo-pp-cli doctor
验证设置是否正确。

Agent Mode

代理模式

Add
--agent
to any command. Expands to:
--json --compact --no-input --no-color --yes
.
  • Pipeable — JSON on stdout, errors on stderr
  • Filterable
    --select
    keeps a subset of fields. Dotted paths descend into nested structures; arrays traverse element-wise. Critical for keeping context small on verbose APIs:
    bash
    klaviyo-pp-cli accounts get --agent --select id,name,status
  • Previewable
    --dry-run
    shows the request without sending
  • 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,错误信息输出到标准错误
  • 可筛选
    --select
    参数保留部分字段。点路径可深入嵌套结构;数组按元素遍历。对于冗长的API,这是缩小上下文范围的关键:
    bash
    klaviyo-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
.results
for data and
.meta.source
to know whether it's live or local. A human-readable
N results (live)
summary is printed to stderr only when stdout is a terminal — piped/agent consumers get pure JSON on stdout.
从本地存储或API读取数据的命令会将输出包装在来源信封中:
json
{
  "meta": {"source": "live" | "local", "synced_at": "...", "reason": "..."},
  "results": <data>
}
解析
.results
获取数据,
.meta.source
用于判断数据是实时的还是本地的。仅当标准输出为终端时,才会在标准错误输出中打印人类可读的
N results (live)
摘要 — 管道/代理消费者仅会在标准输出获取纯JSON。

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 10
Entries are stored locally at
~/.klaviyo-pp-cli/feedback.jsonl
. They are never POSTed unless
KLAVIYO_FEEDBACK_ENDPOINT
is set AND either
--send
is passed or
KLAVIYO_FEEDBACK_AUTO_SEND=true
. Default behavior is local-only.
Write 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
反馈条目存储在本地
~/.klaviyo-pp-cli/feedback.jsonl
文件中。仅当设置了
KLAVIYO_FEEDBACK_ENDPOINT
且传递了
--send
参数或
KLAVIYO_FEEDBACK_AUTO_SEND=true
时,反馈才会被POST发送。默认行为仅存储在本地。
请记录让你感到意外的内容,而非正式的错误报告。简短、具体、单条内容:这样的反馈会更有价值。

Output Delivery

输出交付

Every command accepts
--deliver <sink>
. 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:
SinkEffect
stdout
Default; write to stdout only
file:<path>
Atomically write output to
<path>
(tmp + rename)
webhook:<url>
POST the output body to the URL (
application/json
or
application/x-ndjson
when
--compact
)
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.
每个命令都支持
--deliver <sink>
参数。输出会发送到指定的sink,同时也会(或替代)发送到标准输出,因此代理无需手动管道即可路由命令结果。支持三种sink:
Sink效果
stdout
默认;仅输出到标准输出
file:<path>
原子性地将输出写入
<path>
(先写入临时文件再重命名)
webhook:<url>
将输出体POST到指定URL(当使用
--compact
时为
application/json
application/x-ndjson
未知的协议会被拒绝,并返回结构化错误说明支持的协议类型。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 --yes
Explicit flags always win over profile values; profile values win over defaults.
agent-context
lists all available profiles under
available_profiles
so introspecting agents discover them at runtime.
配置文件是一组保存的标志值,可在多次调用中复用。当调度代理每次运行都使用相同配置调用同一命令时,可使用此功能 — 即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-context
会在
available_profiles
下列出所有可用配置文件,因此自省代理可在运行时发现这些配置文件。

Exit Codes

退出码

CodeMeaning
0Success
2Usage error (wrong arguments)
3Resource not found
4Authentication required
5API error (upstream issue)
7Rate limited (wait and retry)
10Config error
代码含义
0成功
2使用错误(参数错误)
3资源未找到
4需要认证
5API错误(上游问题)
7调用频率受限(等待后重试)
10配置错误

Argument Parsing

参数解析

Parse
$ARGUMENTS
:
  1. Empty,
    help
    , or
    --help
    → show
    klaviyo-pp-cli --help
    output
  2. Starts with
    install
    → ends with
    mcp
    → MCP installation; otherwise → see Prerequisites above
  3. Anything else → Direct Use (execute as CLI command with
    --agent
    )
解析
$ARGUMENTS
  1. 为空、
    help
    --help
    → 显示
    klaviyo-pp-cli --help
    输出
  2. install
    开头
    → 以
    mcp
    结尾 → MCP安装;否则 → 参考上方前置条件
  3. 其他内容 → 直接使用(添加
    --agent
    参数执行CLI命令)

MCP Server Installation

MCP服务器安装

  1. Install the MCP server:
    bash
    go install github.com/mvanhorn/printing-press-library/library/marketing/klaviyo/cmd/klaviyo-pp-mcp@latest
  2. Register with Claude Code:
    bash
    claude mcp add klaviyo-pp-mcp -- klaviyo-pp-mcp
  3. Verify:
    claude mcp list
  1. 安装MCP服务器:
    bash
    go install github.com/mvanhorn/printing-press-library/library/marketing/klaviyo/cmd/klaviyo-pp-mcp@latest
  2. 在Claude Code中注册:
    bash
    claude mcp add klaviyo-pp-mcp -- klaviyo-pp-mcp
  3. 验证:
    claude mcp list

Direct Use

直接使用

  1. Check if installed:
    which klaviyo-pp-cli
    If not found, offer to install (see Prerequisites at the top of this skill).
  2. Match the user query to the best command from the Unique Capabilities and Command Reference above.
  3. Execute with the
    --agent
    flag:
    bash
    klaviyo-pp-cli <command> [subcommand] [args] --agent
  4. If ambiguous, drill into subcommand help:
    klaviyo-pp-cli <command> --help
    .
  1. 检查是否安装:
    which klaviyo-pp-cli
    如果未找到,提供安装选项(参考本技能顶部的前置条件)。
  2. 将用户查询与上方独特功能和命令参考中最匹配的命令对应。
  3. 添加
    --agent
    参数执行:
    bash
    klaviyo-pp-cli <command> [subcommand] [args] --agent
  4. 如果存在歧义,查看子命令帮助:
    klaviyo-pp-cli <command> --help