Skip to main content
PUT
Upsert privacy config for organization

Authorizations

x-api-key
string
header
required

Body

application/json

Body for PUT /privacy/config — a full config representation.

Idempotent full replacement: audio_retention_policy is required for this breaking contract; other omitted fields take their defaults rather than preserving prior values (PUT semantics, not PATCH).

audio_retention_policy
enum<string>
required
Available options:
no_audio,
raw,
redacted
pii_scrubbing_enabled
boolean
default:true
scrub_types
string[]

PIIType enum values to scrub

custom_deny_patterns
CustomDenyPattern · object[]
Maximum array length: 128
custom_allow_patterns
CustomAllowPattern · object[]
Maximum array length: 128
score_threshold
number
default:0.4

Presidio confidence threshold

Required range: 0 <= x <= 1
audio_redaction_fill
enum<string>
default:tone_1khz
Available options:
silence,
tone_1khz
supported_languages
string[]

ISO-639-1 codes the org wants to scrub (subset of {en,es,fr,de,pt})

default_language
string
default:en

Fallback language when detection is off or fails

language_detection_enabled
boolean
default:false

Detect language per scrub call; when false default_language is always used

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
pii_scrubbing_enabled
boolean
required
scrub_types
string[]
required
custom_deny_patterns
CustomDenyPattern · object[]
required
custom_allow_patterns
CustomAllowPattern · object[]
required
score_threshold
number
required
audio_retention_policy
enum<string>
required
Available options:
no_audio,
raw,
redacted
audio_redaction_fill
enum<string>
required
Available options:
silence,
tone_1khz
supported_languages
string[]
required
default_language
string
required
language_detection_enabled
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required