Ir al contenido principal
Conversations

Remove a contact from a conversation

Removes a contact (customer or lead) from an existing conversation.

DELETE
/v2/conversations/{id}/participants

Note: You cannot remove the last participant from a conversation.

Path Parameters

  • id - The conversation ID (short ID)

Request Body

FieldTypeRequiredDescription
idstringYesThe Featurebase ID of the contact to remove (24-character ObjectId)
actingAdminIdstringNoAdmin ID performing the action (for attribution)

Response

Returns the updated conversation object.

Example Request

{
  "id": "676f0f6765bdaa7d7d760f88",
  "actingAdminId": "507f1f77bcf86cd799439011"
}

Example Response

{
  "object": "conversation",
  "id": "12345",
  "participants": [
    { "type": "customer", "id": "676f0f6765bdaa7d7d760f89" }
  ],
  ...
}

Error Cases

  • 400 Bad Request - Cannot remove the last participant from a conversation
  • 404 Not Found - Conversation or contact not found in participants

Version Availability

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

Autorizaciones

Authorizationstringheaderobligatorio

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

Parámetros de ruta

idstringobligatorio

Conversation ID (short ID)

Required string length: 1 - 16
Patrón: ^[a-zA-Z0-9]+$
Ejemplo: 12345

Encabezados

Featurebase-Versionenum<string>header

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

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover
Ejemplo: 2026-08-19.orbit

Cuerpo

application/json
actingAdminIdstring

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

Ejemplo: 507f1f77bcf86cd799439011
idstringobligatorio

The Featurebase ID of the contact (customer or lead) to remove

Ejemplo: 676f0f6765bdaa7d7d760f88

Respuesta

application/json

Success

adminAssigneeIdstring | nullobligatorio

ID of the assigned admin

Ejemplo: 507f1f77bcf86cd799439011
awaitingCustomerReplyboolean

Whether we are awaiting a customer reply

Ejemplo: true
botConversationStateenum<string>

State of AI agent handling for this conversation

Opciones disponibles: active, handed_off_to_human, resolved
Ejemplo: active
botConversationStateLastUpdatedAtstring | nullobligatorio

ISO timestamp when bot state last changed

Ejemplo: 2025-01-15T10:30:00.000Z
brandIdstring | nullobligatorio

ID of the brand associated with this conversation

Ejemplo: 507f1f77bcf86cd799439011
conversationPartsobject[]

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

createdAtstringobligatorio

ISO timestamp when conversation was created

Ejemplo: 2025-01-15T10:30:00.000Z
csatDebugobject

Minimal CSAT diagnostics for the current effective request.

csatHistoryobject[]

Historical CSAT requests for this conversation, ordered newest first.

csatSummaryobject

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

customAttributeValuesobject[]

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

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

Ejemplo: false
hasAdminOverriddenLanguagebooleanobligatorio

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

Ejemplo: false
idstringobligatorio

Unique conversation identifier

Ejemplo: 12345
isBlockedbooleanobligatorio

Whether the user is blocked

Ejemplo: false
lastActivityAtstring | nullobligatorio

ISO timestamp of last activity

Ejemplo: 2025-01-15T12:30:00.000Z
objectenum<string>obligatorio

Object type identifier

Opciones disponibles: conversation
Ejemplo: conversation
participantsobject[]obligatorio

Participants in this conversation

prioritybooleanobligatorio

Whether this conversation is marked as priority

Ejemplo: false
prioritySetAtstring | nullobligatorio

ISO timestamp when priority was set

Ejemplo: 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.

snoozedUntilstring | nullobligatorio

ISO timestamp until which conversation is snoozed

Ejemplo: 2025-01-16T09:00:00.000Z
sourceobject
stateenum<string>obligatorio

Current state of the conversation

Opciones disponibles: open, closed, snoozed
Ejemplo: open
tagsobject[]obligatorio

Current tags applied anywhere in this conversation

teamAssigneeIdstring | nullobligatorio

ID of the assigned team

Ejemplo: 507f1f77bcf86cd799439012
titlestring

Conversation title

Ejemplo: Question about pricing
updatedAtstringobligatorio

ISO timestamp when conversation was last updated

Ejemplo: 2025-01-15T12:30:00.000Z
userPreferredLanguagestringobligatorio

User's preferred language

Ejemplo: en
waitingSincestring | nullobligatorio

ISO timestamp when conversation started waiting

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

¿Aún necesitas ayuda? Pregunta al equipo