MImirakl
Conversations

createConversation - Create a new conversation

Changed on
<div class="extension-title">Description</div>

Use this API to initiate a new conversation with a customer on a marketplace. Returns an action identifier to track the asynchronous processing.

<div class="api-description-extension"> </div>
post/conversations

Request

Request body multipart/form-data

filesstring[]

Optional file attachments

Example request

{
  "conversation": {
    "entity": {
      "id": "0123_Order1-A"
    },
    "first_message": {
      "body": "Hello! How can I assist you today?"
    },
    "topic": {
      "value": "Customer has a general question about services."
    }
  }
}

Response

Conversation creation initiated

action_idstring required

Unique identifier of the action. Use getConversationActionStatus to retrieve the result of your request.

Example response

{
  "action_id": "abcd"
}

Changes

  • d12b10bceb6aRevision changes
    • breaking

      request property // was restricted to a list of enum values

    • breaking

      request property // was restricted to a list of enum values

    • info

      added the new FREE_TEXT enum value to the request property //

    • info

      added the new ORDER enum value to the request property //