Skip to main content
PUT

Authorizations

Authorization
string
header
required

Locus Pro dashboard session (Cognito). High-risk workspace administration requires an owner or admin role and fresh MFA/passkey step-up.

Headers

X-Locus-Step-Up
string<password>

Short-lived raw MFA/passkey step-up token bound to the authenticated Cognito subject. Send it alongside the dashboard Bearer token for workspace-administrator mutations when the base session does not itself prove MFA within the last ten minutes. Never send it with a tenant secret key.

Body

application/json
monthlyLimitUsd
string | null

Hard monthly ceiling, or null to remove it.

Pattern: ^\d+(?:\.\d{1,6})?$
alertThresholdUsd
string | null

Monthly spend email trigger, or null to remove it. Lowering it below current spend triggers the alert immediately.

Pattern: ^\d+(?:\.\d{1,6})?$
lowBalanceAlertUsd
string | null

Remaining prepaid-balance threshold for a one-time email, or null to remove it. The alert re-arms after the balance recovers above the threshold.

Pattern: ^\d+(?:\.\d{1,6})?$

Response

Updated controls

success
any
required
controls
object
required

Account-wide monthly spend controls and low-balance notification state, plus the live position in the current UTC month window. Available to Personal and enterprise accounts. Amounts are exact USD decimal strings.