affiliate

PATCH `/v1/affiliate`

Change your commission line or how you are paid.

Wszystkie dokumentacje dla programistów →

Uwierzytelnianie

Wyślij klucz API jako token bearer. Ten punkt końcowy nie określa konkretnego uprawnienia w specyfikacji, więc nadaj swojemu kluczowi minimum potrzebnych uprawnień i sprawdź odpowiedź zamiast zakładać.

Miejsce na identyfikator organizacji

Ten punkt końcowy przyjmuje org_id jako parametr zapytania. Pomiń go, a wywołanie obejmie całe drzewo dzierżawy; prześlij go, aby ograniczyć wywołanie do jednej organizacji.

Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.

Wypróbuj

Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.

curl -X PATCH https://api.zinndigital.com/v1/affiliate \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API

Szczegóły

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.

Parametry

Nazwa	Typ	Wymagane	Co to jest
`org_id (query)`	`string`	Nie	—

Treść żądania

Nazwa	Typ	Wymagane	Co to jest
`commission_plan`	`string<recurring_12m, lifetime>`	Nie	—
`payout_destination`	`string<wallet, cash>`	Nie	—

Odpowiedź

Nazwa	Typ	Wymagane	Co to jest
`id`	`string`	Tak	—
`org_id`	`string`	Tak	—
`state`	`string<pending, approved, rejected, suspended>`	Tak	—
`code`	`string`	Tak	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`	Tak	The link to share — the public site with `?ref=CODE`.
`commission_plan`	`string<recurring_12m, lifetime>`	Tak	The line new referrals will be created on. Changing it never affects customers already referred.
`payout_destination`	`string<wallet, cash>`	Tak	—
`kyc_state`	`string<not_required, required, submitted, verified, rejected>`	Tak	—
`review_note`	`string`	Nie	—
`terms_accepted_at`	`string`	Nie	—
`applied_at`	`string`	Nie	—

Błędy, które ten punkt końcowy może zwrócić

401 · 403 · 404 · 422