tenancy

PATCH `/v1/orgs/{orgId}`

Rename an organization.

所有 tenancy 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。该密钥必须具有 org.update 权限；缺少该权限的密钥将被拒绝并返回 403 状态码，而非 404。

您的组织 ID 应填在此处

此端点直接在 URL 中接受您的组织 ID，即 orgId。请将其替换到路径中——没有其他标头或查询参数可以替代此操作。

您的组织ID位于控制面板的API密钥屏幕上，就在密钥本身的旁边。这是您在每次调用时使用的相同ID。

免费试用

将尖括号中的内容替换为您自己的值，并将键占位符替换为您仪表板中的一个键。

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