tenancy

PATCH `/v1/orgs/{orgId}`

Rename an organization.

प्रमाणीकरण

बेरर टोकन म्हणून API की पाठवा. की मध्ये org.update परवानगी असणे आवश्यक आहे; ती नसलेली की 404 ऐवजी 403 सह नाकारली जाते.

जिथे तुमचा ऑर्गनायझेशन आयडी (organization id) जाईल

हा एन्डकॉप्ट तुमच्या संस्थेची आयडी थेट URL मध्ये orgId म्हणून घेतो. तो पाथमध्ये टाका — त्यासाठी दुसरा कोणताही हेडर किंवा क्वेरी पॅरामीटर चालणार नाही.

तुमची संस्था आयडी (organisation id) तुमच्या डॅशबोर्डवरील API की स्क्रीनवर, की च्या बाजूला आहे. तुम्ही केलेल्या प्रत्येक कॉलमधील तोच आयडी असतो.

प्रयत्न करा

कोनसांस्कृतिक कंसात (<>) असलेली कोणतीही गोष्ट तुमच्या स्वतःच्या मूल्यांनी बदला आणि 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 विरुद्ध विनंती कार्यान्वित करतो जेणेकरून तुम्हाला वास्तविक प्रतिसाद पाहता येईल. एपी कन्सोलमध्ये हा एंडपॉइंट उघडा

तपशील

⛔ 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}