Brevo

brevo Automated Messages API

Create, manage, and retrieve automated messages pushed to visitors.

Documentation GitHub OpenAPI

Business capability

In-App Chat AE-150.40

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /conversations/pushedMessages Send an automated message to a visitor · Send an automated message #

Ask an LLM

“How do I send a proactive welcome message to a website visitor?”

“Can a scripted bot message be sent on behalf of an agent group?”

Tell an agent

Send automated message {text} to visitor {visitorId}.

Send {text} to visitor {visitorId} as agent {agentId}.

GET /conversations/pushedMessages/{pushedMessageId} Get an automated message · Get an automated message #

Ask an LLM

“What was in a particular automated message?”

“Can I retrieve a pushed message by its identifier?”

Tell an agent

Get automated message {pushedMessageId}.

Show pushed message {pushedMessageId}.

PUT /conversations/pushedMessages/{pushedMessageId} Update an automated message · Update an automated message #

Ask an LLM

“Can I change the wording of an automated message already sent?”

“How do I edit a proactive message's content?”

Tell an agent

Change automated message {pushedMessageId} to {text}.

Update the content of pushed message {pushedMessageId} to read {text}.

DELETE /conversations/pushedMessages/{pushedMessageId} Delete an automated message · Delete an automated message #

Ask an LLM

“How do I permanently delete an automated message?”

“Can I remove a pushed message from the chat history?”

Tell an agent destructive · confirm first

Delete automated message {pushedMessageId}.

Permanently remove pushed message {pushedMessageId}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/brevo:brevo-automated-messages-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Brevo Conversations Automated Messages API
  description: The Brevo Conversations API provides programmatic access to live chat and messaging features for customer support and engagement. It enables developers to manage chat conversations, send and receive messages, and integrate Brevo's chat widget into websites and applications. The API supports real-time communication with site visitors and can be used to build custom chat interfaces, automate responses, and route conversations to appropriate team members.
  version: '3.0'
  contact:
    name: Brevo Support
    url: https://help.brevo.com
  termsOfService: https://www.brevo.com/legal/termsofuse/
servers:
- url: https://api.brevo.com/v3
  description: Brevo Production API Server
security:
- apiKeyAuth: []
tags:
- name: Automated Messages
  description: Create, manage, and retrieve automated messages pushed to visitors.
paths:
  /conversations/pushedMessages:
    post:
      operationId: createAutomatedMessage
      summary: Send an automated message
      description: Creates and sends an automated message to a visitor. Automated messages can be used for proactive engagement, welcome messages, or scripted bot responses.
      tags:
      - Automated Messages
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateAutomatedMessage'
      responses:
        '200':
          description: Automated message sent successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomatedMessageResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /conversations/pushedMessages/{pushedMessageId}:
    get:
      operationId: getAutomatedMessage
      summary: Get an automated message
      description: Retrieves the details of a specific automated message by its unique identifier.
      tags:
      - Automated Messages
      parameters:
      - name: pushedMessageId
        in: path
        required: true
        description: Unique identifier of the automated message.
        schema:
          type: string
      responses:
        '200':
          description: Automated message retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomatedMessageResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Automated message not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: updateAutomatedMessage
      summary: Update an automated message
      description: Updates the content of an existing automated message.
      tags:
      - Automated Messages
      parameters:
      - name: pushedMessageId
        in: path
        required: true
        description: Unique identifier of the automated message.
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateAutomatedMessage'
      responses:
        '200':
          description: Automated message updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomatedMessageResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Automated message not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: deleteAutomatedMessage
      summary: Delete an automated message
      description: Permanently deletes an automated message.
      tags:
      - Automated Messages
      parameters:
      - name: pushedMessageId
        in: path
        required: true
        description: Unique identifier of the automated message.
        schema:
          type: string
      responses:
        '204':
          description: Automated message deleted successfully
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Automated message not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AutomatedMessageResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the automated message.
        visitorId:
          type: string
          description: Unique identifier of the visitor.
        text:
          type: string
          description: Text content of the automated message.
        agentId:
          type: string
          description: Agent attributed to the message.
        createdAt:
          type: string
          format: date-time
          description: UTC date-time when the message was created.
    UpdateAutomatedMessage:
      type: object
      required:
      - text
      properties:
        text:
          type: string
          description: Updated text content of the automated message.
    CreateAutomatedMessage:
      type: object
      required:
      - visitorId
      - text
      properties:
        visitorId:
          type: string
          description: Unique identifier of the visitor to send the automated message to.
        text:
          type: string
          description: Text content of the automated message.
        agentId:
          type: string
          description: Unique identifier of the agent to attribute the message to.
        groupId:
          type: string
          description: Group identifier for routing the conversation.
    ErrorResponse:
      type: object
      properties:
        code:
          type: string
          description: Error code identifying the type of error.
        message:
          type: string
          description: Human-readable description of the error.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: api-key
      description: Brevo API key passed in the api-key request header for authentication.
externalDocs:
  description: Brevo Conversations Documentation
  url: https://developers.brevo.com/docs/getting-started-with-conversations-api

brevo Automated Messages API

Operations 4

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification