reseller
POST /v1/reseller/services/{siteId}/suspend
Put a client's site on a non-payment hold.
Autentifikacija
Pošaljite API ključ kao nosivi token. Ključ mora imati dozvolu reseller.provision; ključ bez nje se odbija s kodom 403, a ne 404.
Gdje dolazi ID vaše organizacije
Ova krajnja točka uzima org_id kao parametar upita. Izostavite ga i poziv obuhvaćett cijelo stablo vašeg najma; pošaljite ga kako biste suzili poziv na jednu organizaciju.
ID vaše organizacije nalazi se na zaslonu API ključeva u vašoj nadzornoj ploči, pored samog ključa. To je isti ID u svakom pozivu koji uputite.
Isprobajte
Zamijenite sve unutar šiljastih zagrada svojim vlastitim vrijednostima, a rezervirano mjesto za ključ s ključem iz vaše nadzorne ploče.
curl -X POST https://api.zinndigital.com/v1/reseller/services/{siteId}/suspend \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'Prijavljeni ste? API konzola na vašoj nadzornoj ploči automatski unosi stvarni ID vaše organizacije i vaš vlastiti ključ te šalje zahtjev prema aktivnom API-ju kako biste mogli vidjeti stvarni odgovor. Otvori ovu krajnju točku u API konzoli
Pojedinosti
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.
Parametri
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
siteId (path) | Uuid | Da | Site ID (UUIDv7). |
org_id (query) | Uuid | Ne | 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 r… |
Tijelo zahtjeva
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
reason | string | Ne | Your own note for the audit trail — typically the invoice number that went unpaid. Recorded against the suspension; never shown to the client. |
Odgovor
| Naziv | Vrsta | Obavezno | Što je to |
|---|---|---|---|
site_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_id | Uuid | Da | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
client_org_name | string | Da | — |
primary_domain | string | Da | — |
name | string | Ne | — |
status | SiteStatus | Da | 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 t… |
product_line | object | Ne | — |
plan_code | object | Ne | — |
plan_name | object | Ne | — |
held_by_reseller | boolean | Ne | 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 fals… |
pending_deletion_at | object | Ne | When a scheduled deletion falls due, or null. |
sell_amount_minor | object | Ne | 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. N… |
sell_currency | object | Ne | — |
created_at | string | Da | — |
Pogreške koje ova krajnja točka može vratiti
401 · 403 · 404 · 409 · 422 · 429