reseller

PUT `/v1/reseller/vendor-policy/clients/{orgId}`

Cap or pause one client's paid data checks.

Autenticación

Envía una clave de API como token de portador. La clave debe tener el permiso reseller.manage; una clave que no lo tenga se rechazará con un código 403, no 404.

Donde va el ID de tu organización

Este endpoint toma el id de tu organización directamente en la URL, como orgId. Sustitúyelo en la ruta; no hay ninguna cabecera ni parámetro de consulta que sirva para ello.

El id de tu organización se encuentra en la pantalla de claves de API en tu panel de control, junto a la propia clave. Es el mismo id en cada llamada que realices.

Pruébalo

Reemplaza cualquier elemento entre corchetes angulares por tus propios valores, y el marcador de posición key con una clave de tu panel de control.

curl -X PUT https://api.zinndigital.com/v1/reseller/vendor-policy/clients/{orgId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

¿Has iniciado sesión? La consola de la API en tu panel de control rellena el ID de tu organización real y tu propia clave, y ejecuta la solicitud contra la API en vivo para que puedas ver la respuesta real. Abre este endpoint en la consola de la API

Detalles

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`.

Parámetros

Nombre	Tipo	Obligatorio	¿Qué es esto?
`orgId (path)`	`Uuid`	Sí	The client organization to cap. Must be one of your own clients.

Cuerpo de la solicitud

Nombre	Tipo	Obligatorio	¿Qué es esto?
`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	—

Respuesta

Nombre	Tipo	Obligatorio	¿Qué es esto?
`seo_data_mode`	`string<own_keys, platform_pool>`	Sí	`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`	Sí	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`	Sí	Basis points of the pool at which you are warned. 8000 = 80%.
`client_overrides`	`ResellerClientVendorRow[]`	Sí	Every one of your clients, including those you have never capped — a client with no cap set appears with `daily_lookup_cap: null`.

Errores que este endpoint puede devolver

401 · 403 · 404 · 422 · 429