Skip to main content
POST
/
conversations
/
{conversationId}
/
close
Close conversation
curl --request POST \
  --url https://api.helloannie.com/v1/conversations/{conversationId}/close \
  --header 'Content-Type: application/json' \
  --data '
{
  "skipNotifications": false
}
'
{
  "success": true,
  "data": {
    "status": "CLOSING"
  },
  "message": "<string>"
}

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

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

Status response when closing a conversation

message
string
required