Skip to main content
PATCH
Rename the current Organization

Authorizations

Authorization
string
header
required

Microsoft Entra application token issued by the caller's Organization tenant for this multitenant API. Request the .default scope and assign the application the required GV.APIReader, GV.APIContributor, or GV.APIOwner role.

Headers

If-Match
string
required

Exact strong ETag from the current resource. Weak validators, wildcards, and tag lists are rejected.

Maximum string length: 1024

Body

application/json
name
string
required

New name. Leading and trailing spaces are trimmed, and control characters are rejected.

Required string length: 1 - 255

Response

Organization updated.

createdAt
string
required
identityConnection
V1IdentityConnection · object
required

The Microsoft Entra directory connected to this Organization. Each directory connects to one Organization.

lifecycleStatus
enum<string>
required

active is the normal state. read_only means no trial or paid subscription is in effect, so creating Table Pairs and preparing Runs return 402.

Available options:
active,
read_only,
cancelled,
purged
name
string
required
organizationUuid
string<uuid>
required
revision
integer
required

Version of the Organization's settings; a rename increases it. The ETag response header is built from it: send that ETag, not this number, in If-Match.

Required range: x >= 1
updatedAt
string
required