Skip to main content
PUT
Activate or deactivate a list in 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.

listId
string
required

The custom list id.

Body

application/json

The snake_case spellings feed_category and version_id are also accepted.

enabled
boolean
default:true

Anything other than false enables the list.

feedCategory
enum<string>

Required when enabling. The lowercase spellings listed are canonical; the value is matched case-insensitively, so Sanctions is also accepted. The feed must be allowed for the workspace.

Available options:
internal,
sanctions,
pep,
news,
legal,
criminal
versionId
string

Required when enabling. Must be a published version of the list.

Response

Success

Envelope { data: { id, ... } } carrying the requested tenant-configuration record(s).

data
object