affiliate

PATCH `/v1/affiliate`

Change your commission line or how you are paid.

Authentication

Send an API key as a bearer token. The key must carry the affiliate.manage permission; a key without it is refused with 403, not 404.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

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.

Parameters

Name	Type	Required	What it is
`org_id (query)`	`string`	No	—

Request body

Name	Type	Required	What it is
`commission_plan`	`string<recurring_12m, lifetime>`	No	—
`payout_destination`	`string<wallet, cash>`	No	—

Response

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

Errors this endpoint can return

401 · 403 · 404 · 422