Skip to main content
POST
Close conversation

Path Parameters

conversationId
string<uuid>
required

The ID of the conversation to close

Body

Request body for closing a conversation and running post-conversation actions

skipNotifications
boolean
default:false

Whether to skip sending notifications to org users about this conversation. Defaults to false.

Response

Response returned when closing a conversation. Duplicate close requests return the current CLOSING or CLOSED status.

success
enum<boolean>
required
Available options:
true
data
object
required

Status response returned by the idempotent close conversation endpoint

message
string
required