Skip to main content
POST
Redact all messages in a session
Session redaction also clears the session’s saved Session notes, including when the session has notes but no messages. The response counts affected messages; clearing a notepad without messages returns a count of zero. For email sessions, redaction also removes saved email delivery copies and disables existing retries in the affected session and sessions containing linked copies of the redacted messages. This does not recall emails already delivered to recipients. For sessions linked to Genesys Cloud, redaction also removes the copies of the session’s messages kept for retrying deliveries, and messages written before the redaction aren’t brought back into the session afterwards. Messages written after it still arrive. If an affected session is sending an email, or its linked history changes during redaction, the request returns 409 Conflict without applying the redaction. Retry the redaction after the send completes or the history stops changing.

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

Minimum string length: 1
reason
string

Optional reason for redaction

Response

Default Response

success
boolean
required
message
string
required
itemId
string
required
redactionType
enum<string>
required
Available options:
message,
session
affectedCount
number
required
messagesRedacted
number
required