Skip to main content
PATCH
Suspend or reinstate an agent

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

orgSlug
string
required
id
string
required

Body

application/json
schemas
enum<string>[]
required

Fixed PatchOp marker per RFC 7644 section 3.5.2.

Available options:
urn:ietf:params:scim:api:messages:2.0:PatchOp
Example:
Operations
object[]
required

The RFC 7644 patch operations to apply to the agent Agent resource.

Example:

Response

The updated Agent resource with the applied active state.