tenancy

PATCH /v1/orgs/{orgId}

Rename an organization.

모든 tenancy 엔드포인트

인증

Bearer 토큰으로 API 키를 전송하세요. 키는 반드시 org.update 권한을 가지고 있어야 하며, 권한이 없는 키는 404가 아닌 403으로 거부됩니다.

조직 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)UuidOrganization ID (UUIDv7).
orgId (path)Uuid

요청 본문

이름유형필수설명
namestringThe organization's display name. The only editable field.

응답

이름유형필수설명
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypeOrganization type in the tenancy tree.
parent_org_idUuid | null아니요Parent in the tenancy tree; null for a top-level org.
namestring
brand_idobject아니요White-label brand applied to this org's surfaces.
default_currencyCurrencyCodeISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>
created_atstring

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 404 · 422 · 429