Skip to main content
PATCH
Update a preset

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.

presetId
string
required

The preset id.

Body

application/json
configType
enum<string>
required
Available options:
match_scoring,
alert_suppression
label
string
required
Required string length: 1 - 128
config
object
required

The preset configuration for configType.

presetId
string

Optional caller-chosen preset id. On update, the path presetId selects the preset.

Required string length: 1 - 128
description
string
Maximum string length: 1024

Response

Success

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

data
object