tenancy

PATCH `/v1/orgs/{orgId}`

Rename an organization.

සත්‍යාපනය

බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. යතුරෙහි org.update අවසරය තිබිය යුතුය; එය නොමැති යතුරක් 404 ලෙස නොව 403 ලෙස ප්‍රතික්ෂේප කෙරේ.

ඔry ඔබේ සංවිධාන හැඳුනුම් අංකය (organisation id) ඇතුළත් කරන ස්ථානය

මෙම අවසන් ලක්ෂ්‍යය (endpoint) මඟින් ඔබේ සංවිධාන හැඳුනුම්පත (organisation id) URL එක තුළම orgId ලෙස ලබා ගනී. එය මාර්ගයට (path) ආදේශ කරන්න — ඒ සඳහා වෙනත් ශීර්ෂයක් (header) හෝ විමසුම් පරාමිතියක් (query parameter) නොමැත.

ඔබගේ සංවිධාන ID එක ඔබගේ පාලක පුවරුවේ ඇති API යතුරු තිරයේ, යතුරට ඊළඟින් දක්වා ඇත. ඔබ සිදු කරන සෑම ඇමතුමකදීම ඇත්තේ එම ID එකමය.

උත්සාහ කරන්න

<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්‍රතිස්ථාපනය කරන්න.

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

පද්ධතියට පිවිස සිටිනවාද? ඔබගේ උපකරණ පුවරුවේ ඇති API කොන්සෝලය මඟින් ඔබේ සැබෑ ආයතනික හැඳුනුම්පත සහ ඔබේම යතුර පුරවා, සජීවී 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.

පsspil

නම	වර්ගය	අත්‍යවශ්‍යයි	එය කුමක්ද
`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}