Skip to main content
PUT
Update credit limit for an agent in a space
The organization bot token must have the following scopes:
  • workflows:write

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Notion-Version
enum<string>
required

The Admin API version to use for this request.

Available options:
2026-06-01

Path Parameters

agent_id
string<uuid>
required
space_id
string<uuid>
required

Body

application/json
credit_limit
number | null
required

Credit limit maximum. Must be a non-negative whole number of credits; other values are rejected with a validation error. Use null to remove the workspace-admin cap.

Response

credit_limit_by_workspace_admin
number | null
required

Effective workspace-admin cap after the edit, or 'null' when no admin cap applies. Always present so the response shape is stable for clients.

current_credit_usage
number | null
required

The agent's credit usage in the current billing period, or 'null' when the current billing period can't be determined (no known service period).

did_clear_paused_state
boolean
required

Whether this save resumed the workflow from a credit-limit or runaway-credit-usage pause.

enforced_credit_limit
number | null
required

The agent's true enforced credit limit after the edit, the minimum of: 1. 'credit_limit_by_workspace_admin' 2. the agent-creator-set limit This is the floor that actually gates execution and can differ from 'credit_limit_by_workspace_admin' — e.g. when the editor set a lower limit. The workspace default acts as the fallback when both 'credit_limit_by_workspace_admin' and the agent-creator-set limit are null. 'null' when no limit applies.

is_active
boolean
required

Whether the agent is active (not paused) after this edit. 'false' means the edit left or put the agent in a paused state — e.g. setting a cap at or below current usage pauses it, or it was already paused for another reason.