Skip to main content
POST
/
redaction
/
session
Redact all messages in a session
curl --request POST \
  --url https://api.open.cx/redaction/session \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "reason": "Customer requested data removal"
}
'
{
  "success": true,
  "message": "Message successfully redacted",
  "itemId": "123e4567-e89b-12d3-a456-426614174000",
  "redactionType": "message",
  "affectedCount": 1,
  "messagesRedacted": 5
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
sessionId
string
required

The session UUID whose messages will be redacted

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
reason
string

Optional reason for redaction

Example:

"Customer requested data removal"

Response

Session messages have been redacted successfully.

​
success
boolean
required

Whether the redaction was successful

Example:

true

​
message
string
required

Success or error message

Example:

"Message successfully redacted"

​
itemId
string
required

ID of the redacted item (message or session)

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
redactionType
enum<string>
required

Type of redaction performed

Available options:
message,
session
Example:

"message"

​
affectedCount
number
required

Number of items affected

Example:

1

​
messagesRedacted
number
required

Number of messages redacted in the session

Example:

5