Redact a conversation part
POST/v2/conversations/redact
Redacts a conversation part (message) from a conversation. Redaction permanently removes the message content while preserving the conversation structure.
Only human message types can be redacted:
user_msg- Messages from customers/leadsadmin_msg- Messages from adminsemail_msg- Email messagesbot_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.
Redact a conversation part
curl https://do.featurebase.app/v2/conversations/redact \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $FEATUREBASE_API_KEY" \
-d '{
"conversationId": "12345",
"conversationPartId": "67890",
"type": "conversation_part",
"actingAdminId": "507f1f77bcf86cd799439011"
}'{
"id": "12345",
"adminAssigneeId": "507f1f77bcf86cd799439011",
"botConversationStateLastUpdatedAt": "2025-01-15T10:30:00.000Z",
"brandId": "507f1f77bcf86cd799439011",
"createdAt": "2025-01-15T10:30:00.000Z",
"hasAdminOverriddenLanguage": false,
"isBlocked": false,
"lastActivityAt": "2025-01-15T12:30:00.000Z",
"object": "conversation",
"participants": [
{
"id": "676f0f6765bdaa7d7d760f88",
"type": "customer"
}
],
"priority": false,
"prioritySetAt": "2025-01-15T10:30:00.000Z",
"snoozedUntil": "2025-01-16T09:00:00.000Z",
"state": "open",
"tags": [
{
"id": "67ec1234abcd5678ef901234",
"name": "Churn",
"type": "tag"
}
],
"teamAssigneeId": "507f1f77bcf86cd799439012",
"updatedAt": "2025-01-15T12:30:00.000Z",
"userPreferredLanguage": "en",
"waitingSince": "2025-01-15T10:30:00.000Z",
"awaitingCustomerReply": true,
"botConversationState": "active",
"conversationParts": [
{
"id": "1",
"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",
"object": "conversation_part",
"partType": "user_msg",
"updatedAt": "2025-01-15T10:30:00.000Z",
"author": {
"id": "676f0f6765bdaa7d7d760f88",
"type": "customer",
"email": "john@example.com",
"name": "John Doe",
"profilePicture": "https://cdn.example.com/avatars/user.png"
},
"redacted": false,
"tagApplications": [
{
"appliedAt": "2025-01-15T10:30:00.000Z",
"tagId": "67ec1234abcd5678ef901234",
"appliedBy": {
"type": "admin",
"id": "507f1f77bcf86cd799439011",
"name": "John Doe"
},
"removedAt": "2025-01-15T11:00:00.000Z",
"removedBy": {
"type": "admin",
"id": "507f1f77bcf86cd799439011",
"name": "John Doe"
},
"tag": {
"id": "67ec1234abcd5678ef901234",
"name": "Churn",
"type": "tag"
}
}
]
}
],
"csatDebug": {
"requestId": "csat_req_123",
"status": "pending",
"changeLockWindowEndsAt": "2025-01-16T12:30:00.000Z",
"emailDelivery": {
"status": "failed",
"failedAt": "2025-01-15T10:31:00.000Z",
"failureReason": "smtp_bounce",
"messageId": "msg_123",
"sentAt": "2025-01-15T10:31:00.000Z"
},
"lateSubmitWindowEndsAt": "2025-01-16T10:30:00.000Z"
},
"csatHistory": [
{
"channel": "desktop",
"isLatestEffective": true,
"lastUpdatedAt": "2025-01-15T10:35:00.000Z",
"requestedAt": "2025-01-15T10:30:00.000Z",
"requestId": "csat_req_123",
"requestSource": "workflow",
"status": "pending",
"canceledAt": "2025-01-15T10:32:00.000Z",
"changeLockWindowEndsAt": "2025-01-16T12:30:00.000Z",
"emailDelivery": {
"status": "failed",
"failedAt": "2025-01-15T10:31:00.000Z",
"failureReason": "smtp_bounce",
"messageId": "msg_123",
"sentAt": "2025-01-15T10:31:00.000Z"
},
"expiredAt": "2025-01-16T10:30:00.000Z",
"lateSubmitWindowEndsAt": "2025-01-16T10:30:00.000Z",
"ratedAgent": {
"type": "teammate",
"id": "507f1f77bcf86cd799439011"
},
"ratedAt": "2025-01-15T10:35:00.000Z",
"remark": "Thanks for the quick help.",
"score": 4,
"workflow": {
"workflowActionId": "action_123",
"workflowId": "507f1f77bcf86cd799439011",
"workflowRunId": "run_123",
"workflowStepId": "step_123"
}
}
],
"csatSummary": {
"lastUpdatedAt": "2025-01-15T10:35:00.000Z",
"status": "pending",
"canceledAt": "2025-01-15T10:35:00.000Z",
"channel": "desktop",
"expiredAt": "2025-01-15T10:35:00.000Z",
"ratedAgent": {
"type": "teammate",
"id": "507f1f77bcf86cd799439011"
},
"ratedAt": "2025-01-15T10:35:00.000Z",
"remark": "Very helpful support.",
"requestedAt": "2025-01-15T10:30:00.000Z",
"requestId": "csat_req_123",
"requestSource": "workflow",
"score": 5,
"workflow": {
"workflowActionId": "action_123",
"workflowId": "507f1f77bcf86cd799439011",
"workflowRunId": "run_123",
"workflowStepId": "step_123"
}
},
"disableCustomerReply": false,
"readReceipts": [
{
"id": "507f1f77bcf86cd799439011",
"lastReadPartId": "8",
"userType": "admin"
}
],
"source": {
"bodyHtml": "<p>Hi, I have a question about your enterprise plan...</p>",
"bodyMarkdown": "Hi, I have a question about your enterprise plan...",
"channel": "desktop",
"author": {
"id": "676f0f6765bdaa7d7d760f88",
"type": "customer"
},
"deliveredAs": "customer_initiated",
"subject": "Question about pricing",
"url": "https://example.com/pricing"
},
"title": "Question about pricing"
}Returns Examples
{
"id": "12345",
"adminAssigneeId": "507f1f77bcf86cd799439011",
"botConversationStateLastUpdatedAt": "2025-01-15T10:30:00.000Z",
"brandId": "507f1f77bcf86cd799439011",
"createdAt": "2025-01-15T10:30:00.000Z",
"hasAdminOverriddenLanguage": false,
"isBlocked": false,
"lastActivityAt": "2025-01-15T12:30:00.000Z",
"object": "conversation",
"participants": [
{
"id": "676f0f6765bdaa7d7d760f88",
"type": "customer"
}
],
"priority": false,
"prioritySetAt": "2025-01-15T10:30:00.000Z",
"snoozedUntil": "2025-01-16T09:00:00.000Z",
"state": "open",
"tags": [
{
"id": "67ec1234abcd5678ef901234",
"name": "Churn",
"type": "tag"
}
],
"teamAssigneeId": "507f1f77bcf86cd799439012",
"updatedAt": "2025-01-15T12:30:00.000Z",
"userPreferredLanguage": "en",
"waitingSince": "2025-01-15T10:30:00.000Z",
"awaitingCustomerReply": true,
"botConversationState": "active",
"conversationParts": [
{
"id": "1",
"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",
"object": "conversation_part",
"partType": "user_msg",
"updatedAt": "2025-01-15T10:30:00.000Z",
"author": {
"id": "676f0f6765bdaa7d7d760f88",
"type": "customer",
"email": "john@example.com",
"name": "John Doe",
"profilePicture": "https://cdn.example.com/avatars/user.png"
},
"redacted": false,
"tagApplications": [
{
"appliedAt": "2025-01-15T10:30:00.000Z",
"tagId": "67ec1234abcd5678ef901234",
"appliedBy": {
"type": "admin",
"id": "507f1f77bcf86cd799439011",
"name": "John Doe"
},
"removedAt": "2025-01-15T11:00:00.000Z",
"removedBy": {
"type": "admin",
"id": "507f1f77bcf86cd799439011",
"name": "John Doe"
},
"tag": {
"id": "67ec1234abcd5678ef901234",
"name": "Churn",
"type": "tag"
}
}
]
}
],
"csatDebug": {
"requestId": "csat_req_123",
"status": "pending",
"changeLockWindowEndsAt": "2025-01-16T12:30:00.000Z",
"emailDelivery": {
"status": "failed",
"failedAt": "2025-01-15T10:31:00.000Z",
"failureReason": "smtp_bounce",
"messageId": "msg_123",
"sentAt": "2025-01-15T10:31:00.000Z"
},
"lateSubmitWindowEndsAt": "2025-01-16T10:30:00.000Z"
},
"csatHistory": [
{
"channel": "desktop",
"isLatestEffective": true,
"lastUpdatedAt": "2025-01-15T10:35:00.000Z",
"requestedAt": "2025-01-15T10:30:00.000Z",
"requestId": "csat_req_123",
"requestSource": "workflow",
"status": "pending",
"canceledAt": "2025-01-15T10:32:00.000Z",
"changeLockWindowEndsAt": "2025-01-16T12:30:00.000Z",
"emailDelivery": {
"status": "failed",
"failedAt": "2025-01-15T10:31:00.000Z",
"failureReason": "smtp_bounce",
"messageId": "msg_123",
"sentAt": "2025-01-15T10:31:00.000Z"
},
"expiredAt": "2025-01-16T10:30:00.000Z",
"lateSubmitWindowEndsAt": "2025-01-16T10:30:00.000Z",
"ratedAgent": {
"type": "teammate",
"id": "507f1f77bcf86cd799439011"
},
"ratedAt": "2025-01-15T10:35:00.000Z",
"remark": "Thanks for the quick help.",
"score": 4,
"workflow": {
"workflowActionId": "action_123",
"workflowId": "507f1f77bcf86cd799439011",
"workflowRunId": "run_123",
"workflowStepId": "step_123"
}
}
],
"csatSummary": {
"lastUpdatedAt": "2025-01-15T10:35:00.000Z",
"status": "pending",
"canceledAt": "2025-01-15T10:35:00.000Z",
"channel": "desktop",
"expiredAt": "2025-01-15T10:35:00.000Z",
"ratedAgent": {
"type": "teammate",
"id": "507f1f77bcf86cd799439011"
},
"ratedAt": "2025-01-15T10:35:00.000Z",
"remark": "Very helpful support.",
"requestedAt": "2025-01-15T10:30:00.000Z",
"requestId": "csat_req_123",
"requestSource": "workflow",
"score": 5,
"workflow": {
"workflowActionId": "action_123",
"workflowId": "507f1f77bcf86cd799439011",
"workflowRunId": "run_123",
"workflowStepId": "step_123"
}
},
"disableCustomerReply": false,
"readReceipts": [
{
"id": "507f1f77bcf86cd799439011",
"lastReadPartId": "8",
"userType": "admin"
}
],
"source": {
"bodyHtml": "<p>Hi, I have a question about your enterprise plan...</p>",
"bodyMarkdown": "Hi, I have a question about your enterprise plan...",
"channel": "desktop",
"author": {
"id": "676f0f6765bdaa7d7d760f88",
"type": "customer"
},
"deliveredAs": "customer_initiated",
"subject": "Question about pricing",
"url": "https://example.com/pricing"
},
"title": "Question about pricing"
}