Update Conversation

PUT 
/conversations/:conversationId

Update the conversation details based on the conversation ID

Request

Version stringrequired

API Version

Available optionsv3

conversationId stringrequired

Conversation ID as string

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID as string

unreadCountnumber

Count of unread messages in the conversation

starredboolean

Starred status of the conversation.

feedbackobject

Example (auto)

{
  "locationId": "tDtDnQdgm2LXpyiqYvZ6",
  "unreadCount": 1,
  "starred": true,
  "feedback": {}
}

application/json

Successful response

application/json

Schema

Schema

successbooleanrequired

Boolean value as the API response.

conversationobjectrequired

Conversation data of the provided conversation ID.

Example (auto)

{
  "success": true,
  "conversation": {
    "id": "tDtDnQdgm2LXpyiqYvZ6",
    "locationId": "tDtDnQdgm2LXpyiqYvZ6",
    "contactId": "tDtDnQdgm2LXpyiqYvZ6",
    "assignedTo": "tDtDnQdgm2LXpyiqYvZ6",
    "userId": "tDtDnQdgm2LXpyiqYvZ6",
    "lastMessageBody": "Hello, this is the message body",
    "lastMessageDate": "1628008053263",
    "lastMessageType": "TYPE_CALL",
    "unreadCount": 1,
    "inbox": true,
    "starred": true,
    "deleted": false
  }
}