reseller
POST /v1/reseller/services/{siteId}/suspend
Put a client's site on a non-payment hold.
ప్రమాణీకరణ
బీయర్ టోకెన్గా API కీని పంపండి. కీ తప్పనిసరిగా reseller.provision అనుమతిని కలిగి ఉండాలి; అది లేని కీని 404 కాకుండా 403తో తిరస్కరిస్తారు.
మీ సంస్థ ఐడీ ఎక్కడ ఉందో అక్కడ
ఈ ఎండ్పాయింట్ క్వరీ పారామీటర్గా org_idని తీసుకుంటుంది. దీనిని వదిలేస్తే కాల్ మీ మొత్తం టెనెన్సీ సబ్ట్రీని కవర్ చేస్తుంది; ఒకే సంస్థకు కాల్ని పరిమితం చేయడానికి దీన్ని పంపండి.
మీ సంస్థ ఐడి (organisation 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