Send an automated message to a visitor

post https://api.brevo.com/v3/conversations/pushedMessages

Example of automated messages: order status, announce new features in your web app, etc.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

string

Message ID. It can be used for further manipulations with the message.

type

string

"agent" for agents’ messages, "visitor" for visitors’ messages.

agent visitor

text

string

Message text or name of the attached file

subject

string

The subject line of the email message (only for messages sent to email threads).

html

string

The HTML content of the message.

rawUnsafeHtml

string

Unescaped HTML content of the message (may include unsafe HTML).

visitorId

string

visitor’s ID

agentId

string

ID of the agent on whose behalf the message was sent (only in messages sent by an agent).

agentName

string

Agent’s name as displayed to the visitor. Only in the messages sent by an agent.

createdAt

int64

≥ 0

Timestamp in milliseconds.

isPushed

boolean

true for pushed messages

isTrigger

boolean

true for automatic messages from “Targeted chats & triggers” and API (https://developers.brevo.com/docs/javascript-api-reference#sendautomessage)

isMissed

boolean

true for missed and offline messages.

isMissedByVisitor

boolean

true for unread agent’s messages in finished chats.

agentUserpic

string

Only set if the agent has uploaded a profile picture.

receivedFrom

string

In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop.

file

object

filename

string

Name of the file

size

int64

≥ 0

Size in bytes

isImage

boolean

Whether the file is an image

url

URL of the file

imageInfo

object

image info is passed in case the file is an image

from

object

An object containing details about the email sender (applicable only to messages in email threads).

string

name

string

array of objects

An array containing details of the recipients (applicable only to messages in email threads).

object

string

name

string

replyTo

object

An object containing details of the reply-to email address (applicable only to messages in email threads).

string

name

string

array of objects

An array containing details of the carbon copy (CC) recipients (applicable only to messages in email threads).

object

string

name

string

bcc

array of objects

An array containing details of the blind carbon copy (BCC) recipients (applicable only to messages in email threads).

bcc

object

string

name

string

sourceMessageId

string

The ID of the message assigned by the integration source.

forwardedToSourceStatus

object

Status of the message forwarding to the source.

isSuccess

boolean

error

string

integrations

object

Integration details.

Has additional fields

isBot

boolean

true for automated messages generated by an AI bot.

attachments

array of objects

An array of file attachments.

attachments

object

fileName

string

The name of the file.

isInline

string

true for inline files.

inlineId

string

The ID of the inline file.

url

string

The URL of the file.

isImage

boolean

true for images.

size

int64

The size of the file in bytes.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.brevo.com/v3/conversations/pushedMessages \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Newly created message is returned as a response

400Returned when invalid data posted