affiliate

PATCH `/v1/affiliate`

Change your commission line or how you are paid.

Autentifikacija

Pošaljite API ključ kao bearer token. Ova krajnja točka ne navodi određenu dozvolu u specifikaciji, stoga dajte svom ključu najmanje što mu je potrebno i provjerite odgovor umjesto da pretpostavljate.

Gdje dolazi ID vaše organizacije

Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.

ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.

Isprobajte

Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.

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

Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli

Pojedinosti

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.

Parametri

Naziv	Vrsta	Obavezno	Što je to
`org_id (query)`	`string`	Ne	—

Tijelo zahtjeva

Naziv	Vrsta	Obavezno	Što je to
`commission_plan`	`string<recurring_12m, lifetime>`	Ne	—
`payout_destination`	`string<wallet, cash>`	Ne	—

Odgovor

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

Pogreške koje ova krajnja točka može vratiti

401 · 403 · 404 · 422