Creates a new conversation with the data provided
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.
Body
locationId
stringLocation ID as string
Example:
tDtDnQdgm2LXpyiqYvZ6
contactId
stringContact ID as string
Example:
tDtDnQdgm2LXpyiqYvZ6
Headers
Authorization
stringAccess Token
Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
stringAPI Version
Allowed value:
2021-07-28
Responses
200
Successful response
Body
success
booleanIndicates whether the API request was successful.
Example:
true
conversation
objectConversation data of the provided conversation ID.
id
stringUnique identifier for the conversation
Example:
tDtDnQdgm2LXpyiqYvZ6
dateUpdated
stringDate when the conversation was last updated
Example:
2023-10-01T12:00:00Z
dateAdded
stringDate when the conversation was created
Example:
2023-10-01T12:00:00Z
deleted
booleanFlag indicating if this conversation has been deleted
Example:
false
contactId
stringUnique identifier of the contact associated with this conversation
Example:
ve9EPM428kjkvShlRW1KT
locationId
stringUnique identifier of the business location where this conversation takes place
Example:
ve9EPM428kjkvShlRW1KT
lastMessageDate
stringDate of the last message in the conversation
Example:
2023-10-01T12:00:00Z
assignedTo
stringUnique identifier of the team member assigned to this conversation
Example:
ve9EPM428kjkvShlRW1KT
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