tenancy

POST /v1/orgs

Create an organization.

All tenancy endpoints

Authentication

Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

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

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Creates a child organization under the caller's org (reseller creating a client, etc.). Send an `Idempotency-Key` so retries never create duplicates (docs/09 §2).

Parameters

NameTypeRequiredWhat it is
Idempotency-Key (header)stringNoClient-generated key that makes an unsafe request replay-safe: the server stores the first response and returns it verbatim for repeats.

Request body

NameTypeRequiredWhat it is
typeOrgTypeYesOrganization type in the tenancy tree.
parent_org_idUuid | nullNoDefaults to the caller's org when omitted.
namestringYes
default_currencyCurrencyCodeNo

Response

NameTypeRequiredWhat it is
idUuidYesUUIDv7 identifier — sortable by creation time (docs/02 §8).
typeOrgTypeYesOrganization type in the tenancy tree.
parent_org_idUuid | nullNoParent in the tenancy tree; null for a top-level org.
namestringYes
brand_idobjectNoWhite-label brand applied to this org's surfaces.
default_currencyCurrencyCodeYesISO 4217 currency code (money is minor units + this code — CLAUDE.md §2.8).
statusstring<active, suspended, closed>Yes
created_atstringYes

Errors this endpoint can return

401 · 403 · 409 · 422 · 429