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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Brevo

Brevo Deals API

The deals API from Brevo — 8 operation(s) for deals.

Documentation Provider Profile APIs.io OpenAPI GitHub

Brevo Deals 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 Deals. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 11 operations across 8 paths, and defines 26 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.

11 operations 8 paths 26 schemas 1 DELETE6 GET2 PATCH2 POST

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 Deals 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 11

Across 8 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 2 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

deals 11
GET
/crm/pipeline/details
Get pipeline stages
getPipelineStages 1 param → 200400
GET
/crm/pipeline/details/{pipelineID}
Get a pipeline
getAPipeline 2 params → 200400
GET
/crm/pipeline/details/all
Get all pipelines
getAllPipelines 1 param → 200400
GET
/crm/attributes/deals
Get deal attributes
getDealAttributes 1 param → 200400
GET
/crm/deals
Get all deals
getAllDeals 13 params → 200400
POST
/crm/deals
Create a deal
createADeal 1 param body → 201400
GET
/crm/deals/{id}
Get a deal
getADeal 2 params → 200400404
DELETE
/crm/deals/{id}
Delete a deal
deleteADeal 2 params → 204400404
PATCH
/crm/deals/{id}
Update a deal
updateADeal 2 params body → 204400404
PATCH
/crm/deals/link-unlink/{id}
Link and Unlink a deal with contacts and companies
linkAndUnlinkADealWithContactsAndCompanies 2 params body → 204400
POST
/crm/deals/import
Import deals(creation and updation)
importDealsCreationAndUpdation 1 param body → 200400

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are CrmAttributesDealsGetResponsesContentApplicationJsonSchemaItems (6 properties), Deal (4 properties), Pipeline (3 properties), errorModel (2 properties). Each schema is shown below with its type and property counts.

CrmDealsIdDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Pipeline
object
Pipeline details with stages
3 properties
DeleteADealRequestBadRequestError
object
2 properties 2 required
CrmAttributesDealsGetResponsesContentApplicationJsonSchemaItemsAttributeOptionsItems
object
2 properties
CrmDealsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Deals_importDealsCreationAndUpdation_Response_200
object
1 property
GetPipelineStagesRequestBadRequestError
object
2 properties 2 required
CrmAttributesDealsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
CrmDealsGetParametersSort
string
CrmDealsIdPatchRequestBodyContentApplicationJsonSchemaAttributes
object
Attributes for deal update To assign owner of a Deal you can send attributes.dealowner and utilize the account email or ID. If you wish to update the pipeline…
Deals_createADeal_Response_201
object
Created deal id
1 property 1 required
UpdateADealRequestBadRequestError
object
2 properties 2 required
CrmPipelineDetailsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
DealAttributes
object
Deal attributes with values
CrmDealsImportPostRequestBodyContentMultipartFormDataSchemaMapping
object
The mapping options in JSON format. Here is an example of the JSON structure: json { "linkentities": true, // Determines whether to link related entities durin…
errorModel
object
2 properties 1 required
Deal
object
Deal Details
4 properties
CrmDealsPostRequestBodyContentApplicationJsonSchemaAttributes
object
Attributes for deal creation To assign owner of a Deal you can send attributes.dealowner and utilize the account email or ID. If you want to create a deal on a…
ImportDealsCreationAndUpdationRequestBadRequestError
object
1 property
CrmAttributesDealsGetResponsesContentApplicationJsonSchemaItems
object
Deal attribute details
6 properties
Deals_getAllDeals_Response_200
object
List of Deals
1 property
Pipelines
array
List of pipeline
GetAllDealsRequestBadRequestError
object
2 properties 2 required
CrmDealsIdPatchResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
PipelineStagesItems
object
Stage details
2 properties
GetDealAttributesRequestBadRequestError
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brevo-deals-api-openapi.yml Raw ↑

Other APIs Brevo publishes across the network.

brevo Agent Status API
AE Profile APIs.io
brevo Automated Messages API
AE Profile APIs.io
brevo Campaign Statistics API
AE Profile APIs.io
brevo Categories API
AE Profile APIs.io
brevo Contact Attributes API
AE Profile APIs.io
brevo Contact Lists API
AE Profile APIs.io
brevo Contacts API
AE Profile APIs.io
brevo Email Activity API
AE Profile APIs.io
brevo Email Campaigns API
AE Profile APIs.io
brevo Email Templates API
AE Profile APIs.io
brevo Folders API
AE Profile APIs.io
brevo Import API
AE Profile APIs.io
#Deals
← Back to B APIs
API Details
ID
brevo:brevo-deals-api
Base URL
https://api.brevo.com/v3
Docs
https://developers.brevo.com/reference
Provider
Brevo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=brevo-deals-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/brevo-deals-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Brevo Deals 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.