tenancy

PATCH /v1/orgs/{orgId}

Rename an organization.

Semua titik akhir tenancy

Autentikasi

Kirim kunci API sebagai token bearer. Kunci tersebut harus memiliki izin org.update; kunci tanpa izin tersebut akan ditolak dengan status 403, bukan 404.

Tempat ID organisasi Anda dimasukkan

Endpoint ini menggunakan id organisasi Anda di dalam URL itu sendiri, sebagai orgId. Gantikan ke dalam path — tidak ada header atau parameter kueri yang dapat menggantikannya.

ID organisasi Anda berada di layar kunci API di dasbor Anda, di sebelah kunci itu sendiri. Itu adalah ID yang sama dalam setiap panggilan yang Anda buat.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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

Parameter

NamaJenisWajibTentang apa ini
orgId (path)UuidYaOrganization ID (UUIDv7).
orgId (path)UuidYa

Isi permintaan

NamaJenisWajibTentang apa ini
namestringYaThe organization's display name. The only editable field.

Tanggapan

NamaJenisWajibTentang apa ini
idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypeYaOrganization type in the tenancy tree.
parent_org_idUuid | nullTidakParent in the tenancy tree; null for a top-level org.
namestringYa
brand_idobjectTidakWhite-label brand applied to this org's surfaces.
default_currencyCurrencyCodeYaISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>Ya
created_atstringYa

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422 · 429