POST /conversations/messages

Options

Body

Request body which must comply to the following JSON Schema:

{
  "required" : [ "text", "visitorId" ],
  "type" : "object",
  "properties" : {
    "visitorId" : {
      "description" : "visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>"
    },
    "text" : {
      "description" : "message text"
    },
    "agentId" : {
      "description" : "agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required)."
    },
    "receivedFrom" : {
      "description" : "mark your messages to distinguish messages created by you from the others."
    },
    "agentEmail" : {
      "description" : "agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address."
    },
    "agentName" : {
      "description" : "agent name"
    }
  }
}

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers