affiliate
PATCH /v1/affiliate
Change your commission line or how you are paid.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
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