reseller
PUT /v1/reseller/vendor-policy/clients/{orgId}
Cap or pause one client's paid data checks.
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 your organisation id in the URL itself, as orgId. Substitute it into the path — there is no header or query parameter that will do instead.
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 PUT https://api.zinndigital.com/v1/reseller/vendor-policy/clients/{orgId} \
-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
Per-client control inside your own pool. `daily_lookup_cap` can only ever **reduce** what that client's plan already grants — a number above their plan allowance has no effect, because the smaller of the two is what is applied. `billed_data_enabled: false` stops that client drawing on your pool at all; their plan, their sites and their history are untouched and they still see readings already paid for. An org id that is not one of your clients is a 404. Requires `reseller.manage`.
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
orgId (path) | Uuid | Yes | The client organization to cap. Must be one of your own clients. |
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
daily_lookup_cap | integer | No | Daily research lookups for this client. `null` removes your cap. Can only reduce what their plan grants. |
billed_data_enabled | boolean | 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