Update the conversation details based on the conversation ID
Request
Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Provide your bearer token in the Authorization header when making requests to protected resources.
Path Parameters
conversationId
stringConversation ID as string
Example:
tDtDnQdgm2LXpyiqYvZ6
Headers
Authorization
stringAccess Token
Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
stringAPI Version
Allowed value:
2021-07-28
Body
locationId
stringLocation ID as string
Example:
tDtDnQdgm2LXpyiqYvZ6
unreadCount
numberCount of unread messages in the conversation
Example:
1
starred
booleanStarred status of the conversation.
Example:
true
feedback
objectResponses
200
Successful response
Body
success
booleanBoolean value as the API response.
Example:
true
conversation
objectConversation data of the provided conversation ID.
id
stringContact ID as string
Example:
tDtDnQdgm2LXpyiqYvZ6
locationId
stringLocation ID as string
Example:
tDtDnQdgm2LXpyiqYvZ6
contactId
stringContact ID as string
Example:
tDtDnQdgm2LXpyiqYvZ6
assignedTo
stringAssigned User ID as string
Example:
tDtDnQdgm2LXpyiqYvZ6
userId
stringUser ID as string
Example:
tDtDnQdgm2LXpyiqYvZ6
lastMessageBody
stringLast message body as string
Example:
Hello, this is the message body
lastMessageDate
stringLast message date as UTC
Example:
1628008053263
lastMessageType
stringType of the last message sent/received in the conversation.
Allowed values:
TYPE_CALLTYPE_SMSTYPE_EMAILTYPE_SMS_REVIEW_REQUESTTYPE_WEBCHATTYPE_SMS_NO_SHOW_REQUESTTYPE_CAMPAIGN_SMSTYPE_CAMPAIGN_CALLTYPE_CAMPAIGN_EMAILTYPE_CAMPAIGN_VOICEMAILTYPE_FACEBOOKTYPE_CAMPAIGN_FACEBOOKTYPE_CAMPAIGN_MANUAL_CALLTYPE_CAMPAIGN_MANUAL_SMSTYPE_GMBTYPE_CAMPAIGN_GMBTYPE_REVIEWTYPE_INSTAGRAMTYPE_WHATSAPPTYPE_CUSTOM_SMSTYPE_CUSTOM_EMAILTYPE_CUSTOM_PROVIDER_SMSTYPE_CUSTOM_PROVIDER_EMAILTYPE_IVR_CALLTYPE_ACTIVITY_CONTACTTYPE_ACTIVITY_INVOICETYPE_ACTIVITY_PAYMENTTYPE_ACTIVITY_OPPORTUNITYTYPE_LIVE_CHATTYPE_LIVE_CHAT_INFO_MESSAGETYPE_ACTIVITY_APPOINTMENTTYPE_FACEBOOK_COMMENTTYPE_INSTAGRAM_COMMENTTYPE_CUSTOM_CALLTYPE_INTERNAL_COMMENT
Example:
TYPE_CALL
unreadCount
numberCount of unread messages in the conversation
Example:
1
inbox
booleanInbox status of the conversation.
Example:
true
starred
booleanStarred status of the conversation.
Example:
true
deleted
booleanDeleted status of the conversation.
Example:
false
422
Unprocessable Entity
Body
statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
401
Unauthorized
Body
statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
400
Bad Request
Body
statusCode
number
Example:
400
message
string
Example:
Bad Request