reseller
PATCH /v1/reseller/vendor-policy
Switch between your own vendor keys and Zinn®'s metered pool.
Authentication
Send an API key as a bearer token. The key must carry the reseller.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/reseller/vendor-policy \
-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
`own_keys` runs your clients' SEO and indexing lookups on credentials you connect yourself, and nothing is metered against you here. `platform_pool` runs them on Zinn®'s accounts against the monthly allowance in your programme; when that allowance is spent, further **paid** checks pause for your clients until the month rolls or the pool is raised — nothing is cancelled, no history is lost, and your clients keep seeing the last reading already paid for. Requires `reseller.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
org_id (query) | Uuid | No | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
seo_data_mode | string<own_keys, platform_pool> | No | — |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
seo_data_mode | string<own_keys, platform_pool> | Yes | `own_keys` runs client SEO and indexing lookups on credentials you connect yourself and is free of charge from us. `platform_pool` runs them on Zinn®'s accounts against your mon… |
monthly_pool_micros | integer | Yes | Your monthly allowance of Zinn-funded vendor spend, in USD micros (1,000,000 = $1). Read-only — it is a commercial term of your programme. `null` means **no pool has been set**,… |
alert_at_bps | integer | Yes | Basis points of the pool at which you are warned. 8000 = 80%. |
client_overrides | ResellerClientVendorRow[] | Yes | Every one of your clients, including those you have never capped — a client with no cap set appears with `daily_lookup_cap: null`. |
Errors this endpoint can return
401 · 403 · 404 · 422 · 429