tenancy

PATCH `/v1/orgs/{orgId}`

Rename an organization.

Упълномощаване

Изпратете API ключ като токен за носене. Ключът трябва да притежава разрешението org.update; ключ без него се отхвърля с 403, а не с 404.

Където отива идентификаторът на вашата организация

Този краен пункт приема идентификатора на вашата организация директно в URL адреса като orgId. Заменете го в пътя — няма заглавна част или заявков параметър, които да го заместят.

ИД на вашата организация се намира на екрана с 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 конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в 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`	Да	—

Грешки, които този крайpoint може да върне

401 · 403 · 404 · 422 · 429

PATCH /v1/orgs/{orgId}