Get Conversation

GEThttps://services.leadconnectorhq.com/conversations/{conversationId}
Get 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
Path Parameters
conversationId
string
required

Conversation ID as string

Example:
tDtDnQdgm2LXpyiqYvZ6
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

responses
/
200
contactId
string
required

Unique identifier of the contact associated with this conversation

Example:
ve9EPM428kjkvShlRW1KT
locationId
string
required

Unique identifier of the business location where this conversation takes place

Example:
ve9EPM428kjkvShlRW1KT
deleted
boolean
required

Flag indicating if this conversation has been moved to trash/deleted

Example:
false
inbox
boolean
required

Flag indicating if this conversation is currently in the main inbox view

Example:
true
type
number
required

Communication channel type for this conversation: 1 (Phone), 2 (Email), 3 (Facebook Messenger), 4 (Review), 5 (Group SMS), 6 (Internal Chat - coming soon)

unreadCount
number
required

Number of messages in this conversation that have not been read by the user

Example:
1
assignedTo
string

Unique identifier of the team member currently responsible for handling this conversation

Example:
ve9EPM428kjkvShlRW1KT
id
string
required

Unique identifier for this specific conversation thread

Example:
ve9EPM428kjkvShlRW1KT
starred
boolean

Flag indicating if this conversation has been marked as important/starred by the user

Example:
true

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request