tenants

put_tenant

Create the tenant, or update the one with this external_ref.

Answers 201 when it was created and 200 when it already existed, so it is safe to repeat. Limits above the partner's own are lowered to them. Cost class: write.

put/v1/tenants/{external_ref}

Request

Base URL
https://ndi-api.nace.ai (the document declares no server; this is the origin it was published from)
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/nace/apis/ndi-service/docs/v1/tenants/:external_ref/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

external_refstring required

The partner's own reference for the tenant, such as its account id.

Request body

display_namestring nullable

Human-readable name of the tenant.

disabledboolean nullable

True disables the tenant (its requests answer tenant_disabled); false re-enables it.

workspace_storage_limit_bytesinteger nullable

Allowance for current source-file bytes across this tenant’s managed workspaces. Omit to preserve the allowance; null removes it. Enforcement requires WORKSPACE_STORAGE_LIMITS_ENABLED.

data_retention'short' | 'zero_retention'

Retention for document operations — a client setting, not a request field.

A data-handling guarantee a caller can accidentally opt out of on one endpoint is not a guarantee, so this is configured per client at onboarding and appears in no request body.

Response

Successful Response

idstring uuid required

NDI's id for the tenant; X-NDI-Tenant accepts it too.

external_refstring required

The partner's own reference for the tenant, unique per partner.

display_namestring nullable required

Human-readable name of the tenant.

disabledboolean required

Whether the tenant is disabled. Its data is kept.

data_retention'short' | 'zero_retention' required

Retention for document operations — a client setting, not a request field.

A data-handling guarantee a caller can accidentally opt out of on one endpoint is not a guarantee, so this is configured per client at onboarding and appears in no request body.

created_atstring date-time required

When the tenant was created.

Changes

No recorded changes to this operation across all 1 revision of this API.