affiliate
PATCH /v1/affiliate
Change your commission line or how you are paid.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Де вказується ідентифікатор вашої організації
Цей ендпоїнт приймає org_id як параметр запиту. Залиште його порожнім, і виклик охопить увесь ваше дерево орендарів; надішліть його, щоб звузити виклик до однієї організації.
Ідентифікатор вашої організації знаходиться на екрані API-ключів у вашій панелі керування, поруч із самим ключем. Це той самий ідентифікатор у кожному вашому запиті.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X PATCH https://api.zinndigital.com/v1/affiliate \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого 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