tenancy

PATCH `/v1/orgs/{orgId}`

Rename an organization.

ప్రమాణీకరణ

బీయర్ టోకెన్‌గా API కీని పంపండి. కీ తప్పనిసరిగా org.update అనుమతిని కలిగి ఉండాలి; అది లేని కీని 404 కాకుండా 403తో తిరస్కరిస్తారు.

మీ సంస్థ ఐడీ ఎక్కడ ఉందో అక్కడ

ఈ ఎండ్‌పాయింట్ మీ సంస్థ ఐడీని నేరుగా యూఆర్‌ఎల్‌లోనే orgId రూపంలో తీసుకుంటుంది. దానిని పాత్‌లో మార్చండి — దీనికి బదులుగా పనిచేసే హెడర్ లేదా క్వరీ పారామీటర్ ఏదీ లేదు.

మీ సంస్థ ఐడి (organisation id) మీ డాష్‌బోర్డ్‌లోని API కీస్ స్క్రీన్‌పై, కీ పక్కనే ఉంటుంది. మీరు చేసే ప్రతి కాల్‌లోనూ ఇదే ఐడి ఉపయోగించబడుతుంది.

ప్రయత్నించండి

కోణీయ బ్రాకెట్‌లలో ఉన్న దేన్నైనా మీ స్వంత విలువలతో భర్తీ చేయండి, మరియు కీ ప్లేస్‌హోల్డర్‌ను మీ డాష్‌బోర్డ్ నుండి తీసుకున్న కీతో భర్తీ చేయండి.

curl -X PATCH https://api.zinndigital.com/v1/orgs/{orgId} \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string> }'

సైన్ ఇన్ చేశారా? మీ డ్యాష్‌బోర్డ్‌లోని API కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ API ద్వారా ఆభ్యర్థనను రన్ చేస్తుంది. ఈ ఎండ్‌పాయింట్‌ను API కన్సోల్‌లో తెరిచండి

వివరాలు

⛔ Deliberately narrow: only `name`. `type`, `parent_org_id` and `default_currency` are **not** editable here — re-parenting moves a whole billing relationship and is `tenancy.offboarding`'s job. ⭐ The currency is not un-changeable, it simply is not a patchable field: it has its own route, `POST /v1/orgs/{orgId}/billing-currency` (`changeOrganizationBillingCurrency`), because re-denominating converts the wallet and re-prices live subscriptions rather than writing one column. This description read "a currency change would leave stored prices and issued invoices denominated in something the org no longer claims (#501)" until 2026-08-31, which was true of a patch and was read as *"it cannot be done"*. Requires `org.update` **on that org**; an org you cannot reach answers 404 rather than 403, the same as the GET, so this is never an existence oracle.

పారామీటర్లు

పేరు	రకం	కావలసినది	ఇది ఏమిటి
`orgId (path)`	`Uuid`	అవును	Organization ID (UUIDv7).
`orgId (path)`	`Uuid`	అవును	—

అభ్యర్థన బాడీ

పేరు	రకం	కావలసినది	ఇది ఏమిటి
`name`	`string`	అవును	The organization's display name. The only editable field.

స్పందన

పేరు	రకం	కావలసినది	ఇది ఏమిటి
`id`	`Uuid`	అవును	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`type`	`OrgType`	అవును	Organization type in the tenancy tree.
`parent_org_id`	`Uuid \| null`	కాదు	Parent in the tenancy tree; null for a top-level org.
`name`	`string`	అవును	—
`brand_id`	`object`	కాదు	White-label brand applied to this org's surfaces.
`default_currency`	`CurrencyCode`	అవును	ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
`status`	`string<active, suspended, closed>`	అవును	—
`created_at`	`string`	అవును	—

ఈ ఎండ్‌పాయింట్ తిరిగి ఇవ్వగల లోపాలు

401 · 403 · 404 · 422 · 429

PATCH /v1/orgs/{orgId}