Uwierzytelnianie
Wyślij klucz API jako token bearer. Klucz musi posiadać uprawnienie org.update; klucz bez niego jest odrzucany z kodem 403, a nie 404.
Miejsce na identyfikator organizacji
Ten punkt końcowy pobiera identyfikator Twojej organizacji bezpośrednio z adresu URL jako orgId. Podstaw go w ścieżce — nie ma nagłówka ani parametru zapytania, które mogłyby go zastąpić.
Identyfikator Twojej organizacji znajduje się na ekranie kluczy API w Twoim panelu, obok samego klucza. Jest to ten sam identyfikator w każdym wywołaniu, które wykonujesz.
Wypróbuj
Zastąp wszystko w nawiasach ostrych własnymi wartościami, a zastępczy znacznik klucza kluczem ze swojego pulpitu nawigacyjnego.
curl -X PATCH https://api.zinndigital.com/v1/orgs/{orgId} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "name": <string> }'Zalogowany? Konsola API w Twoim panelu uzupełnia rzeczywiste identyfikator organizacji oraz Twój własny klucz i wykonuje żądanie względem aktywnego API, dzięki czemu możesz zobaczyć rzeczywistą odpowiedź. Otwórz ten punkt końcowy w konsoli API
Szczegóły
⛔ 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.
Parametry
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
orgId (path) | Uuid | Tak | Organization ID (UUIDv7). |
orgId (path) | Uuid | Tak | — |
Treść żądania
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
name | string | Tak | The organization's display name. The only editable field. |
Odpowiedź
| Nazwa | Typ | Wymagane | Co to jest |
|---|---|---|---|
id | Uuid | Tak | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
type | OrgType | Tak | Organization type in the tenancy tree. |
parent_org_id | Uuid | null | Nie | Parent in the tenancy tree; null for a top-level org. |
name | string | Tak | — |
brand_id | object | Nie | White-label brand applied to this org's surfaces. |
default_currency | CurrencyCode | Tak | ISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8). |
status | string<active, suspended, closed> | Tak | — |
created_at | string | Tak | — |
Błędy, które ten punkt końcowy może zwrócić
401 · 403 · 404 · 422 · 429