Update a subset of the org's console settings

PATCH

/v1/admin/orgs/{org_id}/settings

• Production
• Local

Authorizations

• ClerkSession

Parameters

Path Parameters

org_id

required

string

Request Body ^required

Any subset of the org settings; omitted fields are unchanged.

object

org_name

string

default_domain

string

default_onboarding_mode

string

default_mailbox_cap

integer

webhook_signing_prefix

string

x402_mode

string

early_access

boolean

Responses

200

Updated settings.

object

org_name

string

default_domain

string

default_onboarding_mode

string

default_mailbox_cap

integer

webhook_signing_prefix

string

x402_mode

string

early_access

boolean

400

Invalid request.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope

401

Missing or invalid credential.

The canonical error envelope. error is a stable machine code.

object

error

required

Stable error code (e.g. unauthorized, forbidden, not_found, invalid, quota_exceeded, rate_limited).

string

Example

forbidden

message

Human-readable detail (never leaks internals).

string

Example

missing required scope