conversations

/conversations GET

/conversations

List all conversations

Responses

[
  {
    "bmConversationsid": 1000,
    "mm3customersid": 1000,
    "mm3useraccountsid": 1000,
    "title": "Test-title",
    "message": "Thanks to our fantastic customers",
    "status": "Opened",
    "bmstatus": "Unread",
    "createdAt": "2022-12-21T12:00Z",
    "changedAt": "2022-12-21T12:00Z"
  }
]

/conversations POST

/conversations

Create a new conversation

If the payload contains a message then a new message will be created and assigned to this conversation

Request parameters

{
  "bmConversationsid": 1000,
  "mm3customersid": 1000,
  "mm3useraccountsid": 1000,
  "title": "Test-title",
  "message": "Thanks to our fantastic customers",
  "status": "Opened",
  "bmstatus": "Unread",
  "createdAt": "2022-12-21T12:00Z",
  "changedAt": "2022-12-21T12:00Z"
}

Responses

{
  "bmConversationsid": 1000,
  "mm3customersid": 1000,
  "mm3useraccountsid": 1000,
  "title": "Test-title",
  "message": "Thanks to our fantastic customers",
  "status": "Opened",
  "bmstatus": "Unread",
  "createdAt": "2022-12-21T12:00Z",
  "changedAt": "2022-12-21T12:00Z"
}

/conversations/{id} GET

/conversations/{id}

Get the conversation for the given id

Request parameters

Responses

{
  "bmConversationsid": 1000,
  "mm3customersid": 1000,
  "mm3useraccountsid": 1000,
  "title": "Test-title",
  "message": "Thanks to our fantastic customers",
  "status": "Opened",
  "bmstatus": "Unread",
  "createdAt": "2022-12-21T12:00Z",
  "changedAt": "2022-12-21T12:00Z"
}

/conversations/{id} DELETE

/conversations/{id}

Delete a conversation and all of its messages.

Request parameters

Responses

{
  "status": "DELETED",
  "query_id": 1000
}

/conversations/{id} PATCH

/conversations/{id}

Update a conversation

Request parameters

{
  "bmConversationsid": 1000,
  "mm3customersid": 1000,
  "mm3useraccountsid": 1000,
  "title": "Test-title",
  "message": "Thanks to our fantastic customers",
  "status": "Opened",
  "bmstatus": "Unread",
  "createdAt": "2022-12-21T12:00Z",
  "changedAt": "2022-12-21T12:00Z"
}

Responses

{
  "bmConversationsid": 1000,
  "mm3customersid": 1000,
  "mm3useraccountsid": 1000,
  "title": "Test-title",
  "message": "Thanks to our fantastic customers",
  "status": "Opened",
  "bmstatus": "Unread",
  "createdAt": "2022-12-21T12:00Z",
  "changedAt": "2022-12-21T12:00Z"
}

/conversations/{id}/messages GET

/conversations/{id}/messages

Get all messages associated with a conversation

Request parameters

Responses

[
  {
    "bmConversationmessagesid": 2000,
    "bmConversationsid": 1000,
    "message": "Thanks to our fantastic customers",
    "source": "MERCHANT",
    "createdAt": "2022-12-21T12:00Z",
    "changedAt": "2022-12-21T12:00Z"
  }
]

/conversations/{id}/messages POST

/conversations/{id}/messages

Create a new message in a conversation

Request parameters

{
  "bmConversationmessagesid": 2000,
  "bmConversationsid": 1000,
  "message": "Thanks to our fantastic customers",
  "source": "MERCHANT",
  "createdAt": "2022-12-21T12:00Z",
  "changedAt": "2022-12-21T12:00Z"
}

Responses

{
  "bmConversationmessagesid": 2000,
  "bmConversationsid": 1000,
  "message": "Thanks to our fantastic customers",
  "source": "MERCHANT",
  "createdAt": "2022-12-21T12:00Z",
  "changedAt": "2022-12-21T12:00Z"
}

Last modified: 13 September 2024