reseller

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

Cap or pause one client's paid data checks.

אימות

שלחו מפתח API כאסימון נושא (bearer token). על המפתח לכלול את הרשאה reseller.manage; מפתח שאינו כולל אותה יידחה בסטטוס 403, ולא 404.

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את מזהה הארגון שלך בכתובת ה-URL עצמה, בתור orgId. השתמש בו בנתיב — אין כותרת או פרמטר שאילתת חיפוש שיעשו זאת במקומו.

מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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

פרמטרים

שם	סוג	נדרש	מה זה
`orgId (path)`	`Uuid`	כן	The client organization to cap. Must be one of your own clients.

גוף הבקשה

שם	סוג	נדרש	מה זה
`daily_lookup_cap`	`integer`	לא	Daily research lookups for this client. `null` removes your cap. Can only reduce what their plan grants.
`billed_data_enabled`	`boolean`	לא	—

תשובה

שם	סוג	נדרש	מה זה
`seo_data_mode`	`string<own_keys, platform_pool>`	כן	`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`	כן	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`	כן	Basis points of the pool at which you are warned. 8000 = 80%.
`client_overrides`	`ResellerClientVendorRow[]`	כן	Every one of your clients, including those you have never capped — a client with no cap set appears with `daily_lookup_cap: null`.

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 404 · 422 · 429