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 Custom Objects API

The customObjects API from Brevo — 3 operation(s) for customobjects.

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

This API exposes 3 operations across 3 paths, and defines 23 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.

3 operations 3 paths 23 schemas 1 GET2 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 Custom Objects 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 3

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

customObjects 3
POST
/objects/{object_type}/batch/upsert
Create/Update object records in bulk
upsertrecords 2 params body → 202400403404500
GET
/objects/{object_type}/records
Get the list of object records and total records count for an object.
getrecords 6 params → 200400403424500
POST
/objects/{object_type}/batch/delete
Delete multiple object records (up to 1000) asynchronously
batchDeleteObjectRecords 2 params body → 202400403500

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItems (5 properties), Custom_Objects_batchDeleteObjectRecords_Response_202 (2 properties), ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItems0 (2 properties), Custom_Objects_upsertrecords_Response_202 (2 properties). Each schema is shown below with its type and property counts.

ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAttributes
object
Key-value pairs of attribute data for the object record. Each key is the attribute key (e.g., companyname, enginetype), not the attribute label (e.g., "Company…
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItemsOneOf0RecordsItems1
object
1 property
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItems
object
5 properties
Custom_Objects_upsertrecords_Response_202
object
2 properties
ObjectsObjectTypeRecordsGetParametersSort
string
ObjectsObjectTypeBatchUpsertPostRequestBodyContentApplicationJsonSchemaRecordsItems
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItemsOneOf1RecordsItemsOneOf1Identifiers
object
Identifiers attached with the associated object record. Only includes the internal ID.
1 property
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItemsOneOf0RecordsItems0
object
1 property
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItems1
object
2 properties
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItemsOneOf1RecordsItems0
object
1 property
Custom_Objects_getrecords_Response_200
object
2 properties
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItemsOneOf0RecordsItems
ObjectsObjectTypeRecordsGetParametersAssociation
string
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItemsOneOf0RecordsItemsOneOf1Identifiers
object
Identifiers attached with the associated object record.
1 property
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItems
ObjectsObjectTypeBatchDeletePostRequestBodyContentApplicationJsonSchemaIdentifiers
Either ids or extids must be provided, but not both in the same request.
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItems0
object
2 properties
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItemsOneOf1RecordsItems
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsIdentifiers
object
Identifiers for the object record. Supports id (singular, not ids) or extid. - extid: Your external system's identifier for this record. - id: Internal Brevo r…
2 properties
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItemsOneOf1RecordsItemsOneOf0Identifiers
object
Identifiers attached with the associated object record. Only includes the internal ID.
1 property
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItemsOneOf1RecordsItems1
object
1 property
ObjectsObjectTypeRecordsGetResponsesContentApplicationJsonSchemaRecordsItemsAssociationsItemsOneOf0RecordsItemsOneOf0Identifiers
object
Identifiers attached with the associated object record.
1 property
Custom_Objects_batchDeleteObjectRecords_Response_202
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brevo-customobjects-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 Custom Objects 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.