身份验证
请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限，因此请为您的密钥赋予所需的最小权限，并通过检查响应来确认，而不是盲目假设。
您的组织 ID 应填在此处
此端点将 org_id 作为查询参数。不填则调用涵盖您的整个租户子树；发送该参数则将调用范围缩小到一个组织。
您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。
免费试用
将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。
curl -X PATCH https://api.zinndigital.com/v1/affiliate \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'已登录？您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥，并针对实时 API 运行请求，以便您查看实际的响应。 在 API 控制台中打开此端点
详细信息
Gated on `affiliate.manage`. **A change applies to new signups only.** Customers you have already referred keep the terms that were live when they converted — those terms are stored on the referral itself, so nothing here can reprice them.
参数
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
org_id (query) | string | 否 | — |
请求正文
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
commission_plan | string<recurring_12m, lifetime> | 否 | — |
payout_destination | string<wallet, cash> | 否 | — |
响应
| 名称 | 类型 | 必填 | 内容简介 |
|---|---|---|---|
id | string | 是 | — |
org_id | string | 是 | — |
state | string<pending, approved, rejected, suspended> | 是 | — |
code | string | 是 | The referral code. Its alphabet excludes the characters people transcribe wrongly (`0`/`O`, `1`/`I`/`l`), because it is read aloud and typed off a slide. |
referral_url | string | 是 | The link to share — the public site with `?ref=CODE`. |
commission_plan | string<recurring_12m, lifetime> | 是 | The line **new** referrals will be created on. Changing it never affects customers already referred. |
payout_destination | string<wallet, cash> | 是 | — |
kyc_state | string<not_required, required, submitted, verified, rejected> | 是 | — |
review_note | string | 否 | — |
terms_accepted_at | string | 否 | — |
applied_at | string | 否 | — |
此端点可能返回的错误
401 · 403 · 404 · 422