Update redaction config

Update Redaction Config

curl --request PUT \
  --url https://api.operata.io/v1/config/json \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "RAW_BODY": "{ \"key\": \"REDACTION_CONFIG\",     \"value\": {         \"type\":\"BLACKLIST\",         \"fields\":[             \"Attributes.CustomerDetails\" ]  } }"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    RAW_BODY: '{ "key": "REDACTION_CONFIG",     "value": {         "type":"BLACKLIST",         "fields":[             "Attributes.CustomerDetails" ]  } }'
  })
};

fetch('https://api.operata.io/v1/config/json', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.operata.io/v1/config/json"

payload = { "RAW_BODY": "{ \"key\": \"REDACTION_CONFIG\",     \"value\": {         \"type\":\"BLACKLIST\",         \"fields\":[             \"Attributes.CustomerDetails\" ]  } }" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.operata.io/v1/config/json"

	payload := strings.NewReader("{\n  \"RAW_BODY\": \"{ \\\"key\\\": \\\"REDACTION_CONFIG\\\",     \\\"value\\\": {         \\\"type\\\":\\\"BLACKLIST\\\",         \\\"fields\\\":[             \\\"Attributes.CustomerDetails\\\" ]  } }\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

"REDACTION_CONFIG updated"

"REDACTION_CONFIG not valid"

PUT

config

json

Update Redaction Config

curl --request PUT \
  --url https://api.operata.io/v1/config/json \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "RAW_BODY": "{ \"key\": \"REDACTION_CONFIG\",     \"value\": {         \"type\":\"BLACKLIST\",         \"fields\":[             \"Attributes.CustomerDetails\" ]  } }"
}
'

const options = {
  method: 'PUT',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    RAW_BODY: '{ "key": "REDACTION_CONFIG",     "value": {         "type":"BLACKLIST",         "fields":[             "Attributes.CustomerDetails" ]  } }'
  })
};

fetch('https://api.operata.io/v1/config/json', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.operata.io/v1/config/json"

payload = { "RAW_BODY": "{ \"key\": \"REDACTION_CONFIG\",     \"value\": {         \"type\":\"BLACKLIST\",         \"fields\":[             \"Attributes.CustomerDetails\" ]  } }" }
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.operata.io/v1/config/json"

	payload := strings.NewReader("{\n  \"RAW_BODY\": \"{ \\\"key\\\": \\\"REDACTION_CONFIG\\\",     \\\"value\\\": {         \\\"type\\\":\\\"BLACKLIST\\\",         \\\"fields\\\":[             \\\"Attributes.CustomerDetails\\\" ]  } }\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

"REDACTION_CONFIG updated"

"REDACTION_CONFIG not valid"

Replaces the redaction config for your Operata account with the body you send. It’s a full replace, not a patch — the document on disk after the call equals the document you sent. Use it to apply a new allow-list, switch from an allow-list to a deny-list, or extend the field set on an existing config.

Endpoint

PUT https://api.operata.io/v1/config/json

Parameters

Headers

Name	Type	Required	Description
`Content-Type`	string	yes	`application/json`.
`Idempotency-Key`	string	no, not yet honored	Reserved for a future contract. The endpoint is already idempotent — sending the same body twice yields the same final state. See Idempotency.

Body

Name	Type	Required	Description
`key`	string	yes	Always `REDACTION_CONFIG`.
`value`	object	yes	The config document.
`value.type`	string	yes	`WHITELIST` for an allow-list, `BLACKLIST` for a deny-list. One config per account; the two are mutually exclusive.
`value.fields`	array of string	yes	CTR field paths to include (allow-list) or exclude (deny-list). Use dot notation matching the CTR data model. An empty array on a deny-list sends the full CTR; an empty array on an allow-list sends only the mandatory fields.

The Cloud Collector always ships the mandatory CTR fields (for example ContactId, InitiationTimestamp, Queue.Name) regardless of config. You cannot remove them with a deny-list or omit them from an allow-list. PUT /v1/config/json is idempotent. Sending the same body twice yields the same final state — the document on disk after the second call equals the one on disk after the first. Retry safely. See Idempotency for the per-method contract across the API.

Response

200 OK with a plain-text body REDACTION_CONFIG updated.

REDACTION_CONFIG updated

The config is durable as soon as the call returns, but propagation across all collection points can take up to 30 minutes. CTRs from contacts that end before propagation completes may still apply the previous config.

Example

A deny-list that strips one PII attribute from every CTR:

curl -X PUT -u "$OPERATA_GROUP_ID:$OPERATA_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "REDACTION_CONFIG",
    "value": {
      "type": "BLACKLIST",
      "fields": ["Attributes.CustomerDetails"]
    }
  }' \
  "https://api.operata.io/v1/config/json"

const groupId = process.env.OPERATA_GROUP_ID;
const apiToken = process.env.OPERATA_API_TOKEN;
const auth = Buffer.from(`${groupId}:${apiToken}`).toString("base64");

const body = {
  key: "REDACTION_CONFIG",
  value: {
    type: "BLACKLIST",
    fields: ["Attributes.CustomerDetails"],
  },
};

const response = await fetch("https://api.operata.io/v1/config/json", {
  method: "PUT",
  headers: {
    Authorization: `Basic ${auth}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(body),
});

import os, requests

body = {
    "key": "REDACTION_CONFIG",
    "value": {
        "type": "BLACKLIST",
        "fields": ["Attributes.CustomerDetails"],
    },
}

response = requests.put(
    "https://api.operata.io/v1/config/json",
    auth=(os.environ["OPERATA_GROUP_ID"], os.environ["OPERATA_API_TOKEN"]),
    headers={"Content-Type": "application/json"},
    json=body,
)
response.raise_for_status()

Errors

Status	Code	When	Recover
400	`invalid_config`	The body failed validation. Today the wire response is `text/plain` `REDACTION_CONFIG not valid`. Common causes: misspelled `type` (must be exactly `WHITELIST` or `BLACKLIST`), a field path that does not exist in the CTR data model, or malformed JSON.	Check `type`, check each entry in `fields` against the CTR data model, and re-send.

See Errors for shared codes such as 401 unauthorized, 429 rate_limited, and the 5xx family.

Data redaction — what redaction does and how the three endpoints fit together.
Get redaction config — fetch the current config before you replace it.
Delete redaction config — remove the config and revert to the default.
Configure CTR redaction — the step-by-step rollout guide.
Errors — shared status codes and recovery patterns.
Rate limits — per-token request budget.
Idempotency — PUT is idempotent; sending the same body twice yields the same final state.
Versioning — this endpoint lives under /v1.

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

RAW_BODY

string<json>

default:{ "key": "REDACTION_CONFIG", "value": { "type":"BLACKLIST", "fields":[ "Attributes.CustomerDetails" ] } }

required

REDACTION_CONFIG object

Response

200

Get redaction config

Delete redaction config

Overview & quickstart

API essentials

Endpoints — Contacts

Endpoints — Logs

Endpoints — Users

Endpoints — Data redaction

Events & webhooks

Streaming & backends

AI & MCP

Endpoint

Parameters

Headers

Body

Response

Example

Errors

Authorizations

Body

Response

​Endpoint

​Parameters

​Headers

​Body

​Response

​Example

​Errors

​Related

Authorizations

Body

Response

Endpoint

Parameters

Headers

Body

Response

Example

Errors

Related