affiliate

PATCH `/v1/affiliate`

Change your commission line or how you are paid.

Autentizace

Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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

Název	Typ	Požadováno	Co to je
`org_id (query)`	`string`	Ne	—

Tělo požadavku

Název	Typ	Požadováno	Co to je
`commission_plan`	`string<recurring_12m, lifetime>`	Ne	—
`payout_destination`	`string<wallet, cash>`	Ne	—

Odpověď

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

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422