reseller

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

Cap or pause one client's paid data checks.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც მატარებელი ტოკენი (bearer token). გასაღებს უნდა ჰქონდეს reseller.manage ნებართვა; ამის გარეშე გასაღები უარყოფილი იქნება 403 და არა 404 სტატუსით.

სwhere your organisation id goes-ის ადგილი

ეს ენდპოინტი იღებს თქვენი ორგანიზაციის ID-ს თავად URL-ში, როგორც orgId. ჩაანაცვლეთ ის მისამართში — არ არსებობს ჰედერი ან ქუერის პარამეტრი, რომელიც ამას შეცვლის.

თქვენი ორგანიზაციის ID მითითებულია თქვენი სამართავი პანელის API გასაღებების ეკრანზე, თავად გასაღებთან ახლოს. ის ერთნაირია თქვენ მიერ განხორციელებულ ყველა გამოძახებაში.

სცადეთ

შეSubstituted any value inside angle brackets with your own 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 '{  }'

შესული ხართ? თქვენი სამართავ პანელში არსებული API კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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

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