Skip to main content
PATCH
Update a workspace

Authorizations

Authorization
string
header
required

An admin application key: Authorization: Api-Key <token> (or legacy x-api-key). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.

Path Parameters

orgId
string
required

The organization (tenant) id. Must equal the tenant of the admin key.

workspaceId
string
required

A workspace id in this organization. A workspace of another organization is 404.

Body

application/json

Sparse workspace write. An omitted member is preserved; it is never reset. Unknown members, and customLists, are rejected with 400.

name
string
Required string length: 1 - 128
description
string
Maximum string length: 1024
isDefault
boolean
archived
boolean
crrAllowRemote
boolean
crrAllowThirdParty
boolean
crrCrossBorder
boolean
crrFastTransfer
boolean
enableDynamicAlertSuppression
boolean
screeningMatchThresholds
object
monitoringFeedFrequencies
object

Per-feed monitoring cadence for a workspace or a risk tier. A write replaces the whole map: send every feed you want monitored, because a feed you omit is stored empty and is not monitored. unset is rejected here with 400: it is valid on profile groups only.

monitoringRiskFrequencies
object

Per-risk-tier cadence overrides. Name only the tiers to change; an omitted tier is preserved. null is rejected.

monitoringDeltaConfiguration
object
onboardingFeeds
enum<string>[]
Available options:
Internal,
Sanctions,
PEP,
Criminal,
Legal,
Registries,
Ownership,
Offshore,
Open Source,
Social Media,
News,
Geography
profileOnboarding
object

defaultIdvWorkflowId is required when defaultIdvEnabled is true; idv_first requires defaultIdvEnabled.

allowedScreeningFeeds
string[]
searchExcludedSources
string[]
searchExcludedSourcesByChannel
object

Keys: onboarding, monitoring, direct_api, risk_assessment.

matchScoring
object
riskInference
object

Risk inference configuration (version: 1, with onboarding, monitoring, direct_api and risk_assessment workflows).

alertSuppression
object
automaticDisposition
object
roleAwareAdverseMedia
object
adverseMediaRiskClassification
object
agenticAdverseMedia
object

All four workflows (onboarding, monitoring, direct_api, risk_assessment) are required, each { enabled, timeoutSeconds? } with timeoutSeconds 30-180 (default 60).

clientRiskRating
object | null

Customer Risk Rating section. null resets it to the documented defaults; omitting it preserves the stored section.

Response

Success

data
object