Skip to content
Documentation
GuidesAPI ReferenceIntegrations
ArenaPlatform
API Reference/Privacy

Update Privacy Settings

PATCH/v1/account/privacy

Overview

Applies to owned workspaces and keys created by this account. Workspace restrictions cannot loosen account rules. Requires a dashboard session; API keys cannot change account policy.

Authorization

Authorizationstring · headerRequired

Workspace session token sent as Bearer <token>. Authentication guide

Request Body

application/json
zdrobject

Unknown retention policies are excluded when the corresponding restriction is enabled. First-party Anthropic, OpenAI and Google AI Studio endpoints are excluded by their switches.

Show nested fields
otherboolean
anthropicboolean
openaiboolean
googleboolean
xaiboolean
allow_paid_trainingboolean
allow_free_trainingboolean
allow_free_publicationboolean
max_key_daysinteger | null

Maximum lifetime measured from creation. Null allows any lifetime. Existing nonexpiring or overlong keys are rejected. New keys without an explicit expiry inherit the cap; explicit noncompliant expiries are rejected.

Minimum 1 · Maximum 3650

Responses

200Saved policy. Unspecified fields remain unchanged.
application/json
zdrobject

Unknown retention policies are excluded when the corresponding restriction is enabled. First-party Anthropic, OpenAI and Google AI Studio endpoints are excluded by their switches.

Show nested fields
otherboolean
anthropicboolean
openaiboolean
googleboolean
xaiboolean
allow_paid_trainingboolean
allow_free_trainingboolean
allow_free_publicationboolean
max_key_daysinteger | null

Maximum lifetime measured from creation. Null allows any lifetime. Existing nonexpiring or overlong keys are rejected. New keys without an explicit expiry inherit the cap; explicit noncompliant expiries are rejected.

Minimum 1 · Maximum 3650

400Request validation failed.
application/json
errorobjectRequired
Show nested fields
codestringRequired
messagestringRequired
paramstring | null
request_idstring | null
metadataobject

Typed detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.

401Authentication is missing or invalid.
application/json
errorobjectRequired
Show nested fields
codestringRequired
messagestringRequired
paramstring | null
request_idstring | null
metadataobject

Typed detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.

403Authenticated principal lacks permission.
application/json
errorobjectRequired
Show nested fields
codestringRequired
messagestringRequired
paramstring | null
request_idstring | null
metadataobject

Typed detail for some refusals. budget_exceeded (402): limit (key_budget or workspace_budget) and budget with scope, period, limit, usage and resets_at. key_limit_exceeded (402): limit key_spend_limit. access_denied (403): policy (workspace or key), rule (models, providers or products), product, provider and model.