affiliate

PATCH `/v1/affiliate`

Change your commission line or how you are paid.

Pagpapatotoo

Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.

Kung saan mapupunta ang id ng iyong organisasyon

Tinatanggap ng endpoint na ito ang org_id bilang parameter ng query. Huwag itong isama at saklaw ng tawag ang buong subtree ng iyong tenancy; ipadala ito para paliitin ang tawag sa isang organisasyon.

Ang id ng iyong organisasyon ay nasa screen ng mga API key sa iyong dashboard, sa tabi mismo ng key. Ito ang parehong id sa bawat tawag na gagawin mo.

Subukan ito

Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.

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

Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API

Mga Detalye

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.

Mga Parameter

Pangalan	Uri	Kailangan	Ano ito
`org_id (query)`	`string`	Hindi	—

Katawan ng kahilingan

Pangalan	Uri	Kailangan	Ano ito
`commission_plan`	`string<recurring_12m, lifetime>`	Hindi	—
`payout_destination`	`string<wallet, cash>`	Hindi	—

Tugon

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

Mga error na maibabalik ng endpoint na ito

401 · 403 · 404 · 422