organization

Rename Organization

Rename the organization as humans see it. Its storage slug never moves.

patch/api/v1/organizations/{organization_id}

Request

Base URL
https://ndi-api.nace.ai (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nace/apis/ndi-service/docs/api/v1/organizations/:organization_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organization_idstring uuid required

Organization from POST /console/session.

Request body

display_namestring required

Response

Successful Response

organization_idstring uuid required

namestring required

Storage-safe slug, derived server-side. Stable; not shown to users.

display_namestring required

The name a human gave the organization.

role'owner' | 'admin' | 'member' required

The signed-in user's role here. It may differ per organization.

rate_limit_rpminteger required

included_creditsinteger nullable

Lifetime credit allowance; null means unlimited.

joined_atstring date-time required

created_atstring date-time required

default_workspace_idstring uuid nullable

The signed-in user's Perception Playground in this organization — where the console's perception tools upload by default. Null when it has not been provisioned yet, which the console handles by falling back to workspace-free uploads.

Changes

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