Skip to main content
PATCH
Update organization
Requires the IAM action workspace:UpdateOrganization. See WORKSPACE permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

organization_id
string<uuid>
required

Organization ID

Body

application/json
captcha_token
string
required

Google reCAPTCHA token for bot protection

Example:

"03AGdBq24..."

language
enum<string>
default:en

Language for organization billing and operational emails, independent of each user's console preference.

Available options:
en,
pt-BR,
es
time_zone
string
default:UTC

IANA timezone for formatting organization emails. Does not change billing periods or resource schedules.

Example:

"America/Sao_Paulo"

name
string
Required string length: 1 - 255
Example:

"Acme Corporation"

description
string
Maximum string length: 1000
Example:

"Cloud infrastructure for Acme Corporation"

Response

Organization updated

organization
object