Close Conversation Request

Home/

REST API Reference

Payload of the request to close a conversation

message_typestringrequired

Value:"close"

Example:"close"

typestringrequired

Value:"admin"

Example:"admin"

admin_idstringrequired

The id of the admin who is performing the action.

Example:"12345"

bodystring

Optionally you can leave a message in the conversation to provide additional context to the user and other teammates.

Example:" This conversation is now closed!"

assignee_idstring

The id of the admin or team to assign the conversation to when it is closed. Set 0 to unassign it, which clears both the teammate and the team assignee.

Example:"4324241"

skip_notificationsboolean

Option to disable notifications when closing a conversation. Available from API version 2.15.

Example:true

{
  "message_type": "close",
  "type": "admin",
  "admin_id": "12345",
  "body": " This conversation is now closed!",
  "assignee_id": "4324241",
  "skip_notifications": true
}