Conversations

Redact a conversation part

Redacts a conversation part (message) from a conversation. Redaction permanently removes the message content while preserving the conversation structure.

POST

/v2/conversations/redact

curl --request POST \
  --url https://do.featurebase.app/v2/conversations/redact \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit' \
  --header 'Content-Type: application/json' \
  --data '
{
  "actingAdminId": "507f1f77bcf86cd799439011",
  "conversationId": "12345",
  "conversationPartId": "67890",
  "type": "conversation_part"
}
'

{
  "adminAssigneeId": "507f1f77bcf86cd799439011",
  "awaitingCustomerReply": true,
  "botConversationState": "active",
  "botConversationStateLastUpdatedAt": "2025-01-15T10:30:00.000Z",
  "brandId": "507f1f77bcf86cd799439011",
  "conversationParts": [
    {
      "author": {
        "email": "john@example.com",
        "id": "676f0f6765bdaa7d7d760f88",
        "name": "John Doe",
        "profilePicture": "https://cdn.example.com/avatars/user.png",
        "type": "customer"
      },
      "bodyHtml": "<p>Hello, I have a question about your product.</p>",
      "bodyMarkdown": "Hello, I have a question about your product.",
      "channel": "desktop",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "id": "1",
      "object": "conversation_part",
      "partType": "user_msg",
      "redacted": false,
      "slack": {
        "channelId": "C01EFGH",
        "messageTs": "1705313410.001200",
        "teamId": "T01ABCD",
        "threadTs": "1705313400.001100"
      },
      "tagApplications": [
        {}
      ],
      "updatedAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "createdAt": "2025-01-15T10:30:00.000Z",
  "csatDebug": {
    "changeLockWindowEndsAt": "2025-01-16T12:30:00.000Z",
    "emailDelivery": {
      "attempts": 2,
      "claimedAt": "2025-01-15T10:30:59.000Z",
      "failedAt": "2025-01-15T10:31:00.000Z",
      "failureReason": "smtp_bounce",
      "idempotencyKey": "csat:req_123:user_123",
      "messageId": "msg_123",
      "nextAttemptAt": "2025-01-15T10:36:00.000Z",
      "sentAt": "2025-01-15T10:31:00.000Z",
      "status": "failed"
    },
    "lateSubmitWindowEndsAt": "2025-01-16T10:30:00.000Z",
    "requestId": "csat_req_123",
    "slackDelivery": {
      "channelId": "C01EFGH",
      "failedAt": "2025-01-15T10:31:00.000Z",
      "failureReason": "missing_slack_thread_metadata",
      "messageTs": "1705313400.001100",
      "postedAt": "2025-01-15T10:31:00.000Z",
      "status": "posted",
      "teamId": "T01ABCD"
    },
    "status": "pending"
  },
  "csatHistory": [
    {
      "canceledAt": "2025-01-15T10:32:00.000Z",
      "changeLockWindowEndsAt": "2025-01-16T12:30:00.000Z",
      "channel": "desktop",
      "emailDelivery": {
        "attempts": 2,
        "claimedAt": "2025-01-15T10:30:59.000Z",
        "failedAt": "2025-01-15T10:31:00.000Z",
        "failureReason": "smtp_bounce",
        "idempotencyKey": "csat:req_123:user_123",
        "messageId": "msg_123",
        "nextAttemptAt": "2025-01-15T10:36:00.000Z",
        "sentAt": "2025-01-15T10:31:00.000Z",
        "status": "failed"
      },
      "expiredAt": "2025-01-16T10:30:00.000Z",
      "isLatestEffective": true,

Only human message types can be redacted:

user_msg - Messages from customers/leads
admin_msg - Messages from admins
email_msg - Email messages
bot_msg - Bot messages

System-generated conversation parts (assignments, status changes, etc.) cannot be redacted.

Request Body

Field	Type	Required	Description
`type`	string	Yes	The type of item to redact. Currently only `"conversation_part"` is supported.
`conversationId`	string	Yes	The conversation short ID containing the part to redact
`conversationPartId`	string	Yes	The conversation part short ID to redact
`actingAdminId`	string	No	Admin ID performing the action (for attribution)

Response

Returns the updated conversation object.

Example Request

{
  "type": "conversation_part",
  "conversationId": "12345",
  "conversationPartId": "67890",
  "actingAdminId": "507f1f77bcf86cd799439011"
}

Example Response

{
  "object": "conversation",
  "id": "12345",
  "conversationParts": [
    {
      "object": "conversation_part",
      "id": "67890",
      "partType": "user_msg",
      "bodyHtml": "",
      "bodyMarkdown": "",
      "redacted": true,
      ...
    }
  ],
  ...
}

Error Cases

400 Bad Request - Only human messages can be redacted
404 Not Found - Conversation or conversation part not found

Version Availability

This endpoint is only available in API version 2026-01-01.nova and newer.

Authorizations

Authorizationstringheaderrequired

API key as Bearer token. Use: Authorization: Bearer sk_...

Headers

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Available options: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Example: 2026-08-19.orbit

Body

actingAdminIdstring

The admin ID performing this action. If not provided, changes are attributed to the system bot user.

Example: 507f1f77bcf86cd799439011

conversationIdstringrequired

The conversation short ID that contains the part to redact

Required string length: 1 - 16

Pattern: ^[a-zA-Z0-9]+$

Example: 12345

conversationPartIdstringrequired

The conversation part short ID to redact

Required string length: 1 - 16

Pattern: ^[a-zA-Z0-9]+$

Example: 67890

typeenum<string>required

The type of item to redact. Currently only "conversation_part" is supported.

Available options: conversation_part

Example: conversation_part

Response

Success

adminAssigneeIdstring | nullrequired

ID of the assigned admin

Example: 507f1f77bcf86cd799439011

awaitingCustomerReplyboolean

Whether we are awaiting a customer reply

Example: true

botConversationStateenum<string>

State of AI agent handling for this conversation

Available options: active, handed_off_to_human, resolved

Example: active

botConversationStateLastUpdatedAtstring | nullrequired

ISO timestamp when bot state last changed

Example: 2025-01-15T10:30:00.000Z

brandIdstring | nullrequired

ID of the brand associated with this conversation

Example: 507f1f77bcf86cd799439011

conversationPartsobject[]

Array of conversation parts (messages). Only included when fetching a single conversation by ID.

Show child attributes

createdAtstringrequired

ISO timestamp when conversation was created

Example: 2025-01-15T10:30:00.000Z

csatDebugobject

Minimal CSAT diagnostics for the current effective request.

Show child attributes

csatHistoryobject[]

Historical CSAT requests for this conversation, ordered newest first.

Show child attributes

csatSummaryobject

Derived CSAT summary for this conversation when a rating request or rating exists.

Show child attributes

customAttributeValuesobject[]

Custom conversation attribute values expanded with definition metadata. Returned only when include=customAttributeDefinitions is provided.

Show child attributes

customAttributesobject

Custom conversation attributes keyed by custom attribute ID. Only org-defined, non-archived conversation attributes are returned; internal workflow metadata is omitted.

disableCustomerReplyboolean

Whether customer replies are disabled

Example: false

hasAdminOverriddenLanguagebooleanrequired

Whether an admin has manually overridden the language for this conversation. When true, automatic language detection is disabled.

Example: false

idstringrequired

Unique conversation identifier

Example: 12345

isBlockedbooleanrequired

Whether the user is blocked

Example: false

lastActivityAtstring | nullrequired

ISO timestamp of last activity

Example: 2025-01-15T12:30:00.000Z

objectenum<string>required

Object type identifier

Available options: conversation

Example: conversation

participantsobject[]required

Participants in this conversation

Show child attributes

prioritybooleanrequired

Whether this conversation is marked as priority

Example: false

prioritySetAtstring | nullrequired

ISO timestamp when priority was set

Example: 2025-01-15T10:30:00.000Z

readReceiptsobject[]

Read receipts indicating how far each participant has read in the conversation. Each receipt maps a user to their last-read conversation part. The tracked position reflects the system read state and may reference parts the user cannot directly view (e.g., a contact's read position may point to an internal admin note). Use these receipts to render read indicators and typing awareness, not to infer content access.

Show child attributes

snoozedUntilstring | nullrequired

ISO timestamp until which conversation is snoozed

Example: 2025-01-16T09:00:00.000Z

sourceobject

Show child attributes

stateenum<string>required

Current state of the conversation

Available options: open, closed, snoozed

Example: open

tagsobject[]required

Current tags applied anywhere in this conversation

Show child attributes

teamAssigneeIdstring | nullrequired

ID of the assigned team

Example: 507f1f77bcf86cd799439012

titlestring

Conversation title

Example: Question about pricing

updatedAtstringrequired

ISO timestamp when conversation was last updated

Example: 2025-01-15T12:30:00.000Z

userPreferredLanguagestringrequired

User's preferred language

Example: en

waitingSincestring | nullrequired

ISO timestamp when conversation started waiting

Example: 2025-01-15T10:30:00.000Z

Still need help? Ask the team