reseller
POST /v1/reseller/services/{siteId}/suspend
Put a client's site on a non-payment hold.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу reseller.provision; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/reseller/services/{siteId}/suspend \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Suspends a site you resell — the lever a billing panel pulls when your client has not paid you. The site stops serving and its content is retained; nothing is deleted. Requires reseller.provision. The hold is attributed to YOU, and that attribution is load-bearing: a site the malware ladder suspended cannot be released by unsuspendResellerService, and a site you suspended cannot be released from the abuse queue. Two different people hold two different keys to the same door, and neither may open the other's lock.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
siteId (path) | Uuid | Да | Site ID (UUIDv7). |
org_id (query) | Uuid | Не | 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… |
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
reason | string | Не | Your own note for the audit trail — typically the invoice number that went unpaid. Recorded against the suspension; never shown to the client. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
site_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_name | string | Да | — |
primary_domain | string | Да | — |
name | string | Не | — |
status | SiteStatus | Да | A site's lifecycle state (docs/04 §3). A newly created site is pending until the provisioning workflow picks it up; deleted is terminal. restricted and quarantined are the… |
product_line | object | Не | — |
plan_code | object | Не | — |
plan_name | object | Не | — |
held_by_reseller | boolean | Не | True when the current suspension was placed through this surface, which is the only case unsuspendResellerService will release. A site suspended by the abuse desk reports false… |
pending_deletion_at | object | Не | When a scheduled deletion falls due, or null. |
sell_amount_minor | object | Не | What YOU charge for this plan, in minor units of sell_currency — your own price-list row if you have authored one, otherwise our list price with your default markup applied.… |
sell_currency | object | Не | — |
created_at | string | Да | — |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 409 · 422 · 429