How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Brevo Conversations API

The conversations API from Brevo — 6 operation(s) for conversations.

Brevo Conversations API is one of 53 APIs that Brevo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Conversations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 10 operations across 6 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.brevo.com/v3.

10 operations 6 paths 37 schemas 2 DELETE2 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.brevo.com/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Brevo Conversations API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key).

  • api-key — The API key should be passed in the request headers as api-key for authentication.

Paths & Operations 10

Across 6 paths, the API surfaces 10 operations — 2 DELETE, 2 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

conversations 10
DELETE
/conversations/messages/{id}
Delete a message sent by an agent
deleteAMessageSentByAnAgent 2 params → 204400404
PUT
/conversations/messages/{id}
Update a message sent by an agent
updateAMessageSentByAnAgent 2 params body → 200400404
GET
/conversations/messages/{id}
Get a message
getAMessage 2 params → 200400404
POST
/conversations/messages
Send a message as an agent
sendAMessageAsAnAgent 1 param body → 200400
DELETE
/conversations/pushedMessages/{id}
Delete an automated message
deleteAnAutomatedMessage 2 params → 204400404
PUT
/conversations/pushedMessages/{id}
Update an automated message
updateAnAutomatedMessage 2 params body → 200400404
GET
/conversations/pushedMessages/{id}
Get an automated message
getAnAutomatedMessage 2 params → 200400404
POST
/conversations/pushedMessages
Send an automated message to a visitor
sendAnAutomatedMessageToAVisitor 1 param body → 200400
POST
/conversations/agentOnlinePing
Sets agent's status to online for 2-3 minutes
setsAgentsStatusToOnlineFor23Minutes 1 param body → 201400
PUT
/conversations/visitorGroup
Set visitor group assignment
setVisitorGroupAssignment 1 param body → 200400404

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are ConversationsMessage (31 properties), ConversationsMessageFile (10 properties), ConversationsMessageAttachmentsItems (10 properties), ConversationsMessageFileImageInfo (3 properties). Each schema is shown below with its type and property counts.

UpdateAnAutomatedMessageRequestBadRequestError
object
2 properties 2 required
ConversationsMessagesIdDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
DeleteAMessageSentByAnAgentRequestBadRequestError
object
2 properties 2 required
ConversationsMessage
object
a Conversations message
31 properties
SendAnAutomatedMessageToAVisitorRequestBadRequestError
object
2 properties 2 required
ConversationsMessagesIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
UpdateAMessageSentByAnAgentRequestBadRequestError
object
2 properties 2 required
ConversationsPushedMessagesIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ConversationsMessageCcItems
object
2 properties
ConversationsMessageToItems
object
2 properties
ConversationsPushedMessagesIdDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
SetVisitorGroupAssignmentRequestBadRequestError
object
2 properties 2 required
ConversationsMessageAttachmentsItemsImageInfo
object
Image information (only present for image files).
3 properties
ConversationsMessagesPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ConversationsMessagesIdPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Conversations_setsAgentsStatusToOnlineFor23Minutes_Response_201
object
Empty response body
ConversationsMessageAttachmentsItems
object
10 properties
ConversationsMessageForwardedToSourceStatus
object
Status of the message forwarding to the source.
2 properties
ConversationsPushedMessagesPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ConversationsMessageFrom
object
An object containing details about the email sender (applicable only to messages in email threads).
2 properties
ConversationsMessageIntegrations
object
Integration details.
ConversationsAgentOnlinePingPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
errorModel
object
2 properties 1 required
ConversationsMessageFile
object
10 properties
ConversationsMessageFileImageInfo
object
Image info, present when the file is an image.
3 properties
DeleteAnAutomatedMessageRequestBadRequestError
object
2 properties 2 required
GetAMessageRequestBadRequestError
object
2 properties 2 required
ConversationsMessageSource
object
Source information for the message.
ConversationsVisitorGroupPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ConversationsMessageBccItems
object
2 properties
Conversations_setVisitorGroupAssignment_Response_200
object
2 properties
SetsAgentsStatusToOnlineFor23MinutesRequestBadRequestError
object
2 properties 2 required
ConversationsMessageReplyTo
object
An object containing details of the reply-to email address (applicable only to messages in email threads).
2 properties
SendAMessageAsAnAgentRequestBadRequestError
object
2 properties 2 required
ConversationsPushedMessagesIdPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
GetAnAutomatedMessageRequestBadRequestError
object
2 properties 2 required
ConversationsMessageType
string
"agent" for agents’ messages, "visitor" for visitors’ messages.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brevo-conversations-api-openapi.yml Raw ↑

Other APIs Brevo publishes across the network.

brevo Agent Status API
brevo Automated Messages API
brevo Campaign Statistics API
brevo Categories API
brevo Contact Attributes API
brevo Contact Lists API
brevo Contacts API
brevo Email Activity API
brevo Email Campaigns API
brevo Email Templates API
brevo Folders API
brevo Import API
Where this information came from

This is an independent, third-party profile of Brevo Conversations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.