affiliate

PATCH `/v1/affiliate`

Change your commission line or how you are paid.

Pengesahan

Hantar kunci API sebagai token pembawa. Titik akhir ini tidak menyatakan kebenaran tertentu dalam spesifikasi, jadi berikan kunci anda kebenaran minimum yang diperlukan dan semak respons tersebut daripada membuat andaian.

Tempat ID organisasi anda diletakkan

Titik akhir ini mengambil org_id sebagai parameter pertanyaan. Biarkan ia kosong dan panggilan tersebut meliputi keseluruhan subpohon penyewaan anda; hantarkannya untuk mengecilkan panggilan kepada satu organisasi.

ID organisasi anda terletak pada skrin kekunci API dalam papan pemuka anda, di sebelah kekunci itu sendiri. Ia adalah ID yang sama dalam setiap panggilan yang anda buat.

Cuba

Gantikan apa sahaja di dalam kurungan sudut dengan nilai anda sendiri, dan pemegang tempat kunci dengan kunci dari papan pemuka anda.

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

Sudah log masuk? Konsol API dalam papan pemuka anda mengisi id organisasi sebenar dan kunci anda sendiri, serta menjalankan permintaan terhadap API langsung supaya anda boleh melihat respons sebenar. Buka penamat ini dalam konsol API

Butiran

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.

Parameter

Nama	Jenis	Diperlukan	Apakah ia
`org_id (query)`	`string`	Tidak	—

Badan permintaan

Nama	Jenis	Diperlukan	Apakah ia
`commission_plan`	`string<recurring_12m, lifetime>`	Tidak	—
`payout_destination`	`string<wallet, cash>`	Tidak	—

Respons

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

Ralat yang boleh dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422