POST /conversations/messages
Send a message as an agent to an existing visitor's conversation. You must provide either agentId alone, or all three of agentEmail + agentName + receivedFrom to identify the agent.
Servers
- https://api.brevo.com/v3
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
receivedFrom |
String | No |
Mark your messages to distinguish messages created by you from the others. |
text |
String | Yes |
Message text. |
agentId |
String | No |
Agent ID. It can be found on the agent's page or received from a webhook. Alternatively, you can use |
visitorId |
String | Yes |
Visitor's ID received from a webhook or generated by you to bind an existing user account to Conversations. |
agentName |
String | No |
Agent's name. |
agentEmail |
String | No |
Agent's email address. 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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.