Generated by API Evangelist
Written by API Evangelist tooling for Brevo's API. It is a proposal applied on top of the contract, not a document Brevo publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Object Management Custom Objects API
version: 1.0.0
extends: openapi/brevo-custom-objects-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/objects/{object_type}/batch/upsert'].post
update:
x-apievangelist-phrasing:
intent: Create or update custom object records in bulk
effect: write
questions:
- How do I bulk load records into one of my custom objects?
- Will existing custom object records be updated rather than duplicated?
instructions:
- text: Upsert these records {records} into custom object {object_type}.
slots:
records: requestBody.records
object_type: path.object_type
- text: Create or update {object_type} records {records}.
slots:
object_type: path.object_type
records: requestBody.records
method: generated
generated: '2026-10-01'
- target: $.paths['/objects/{object_type}/records'].get
update:
x-apievangelist-phrasing:
intent: List custom object records
effect: read
questions:
- What records exist for one of my custom objects and how many in total?
- Can I include associated records when listing custom objects?
instructions:
- text: List {limit} records of {object_type} on page {page_num}.
slots:
limit: query.limit
object_type: path.object_type
page_num: query.page_num
- text: Show page {page_num} of {object_type} records with associations, {limit} per page.
slots:
page_num: query.page_num
object_type: path.object_type
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/objects/{object_type}/batch/delete'].post
update:
x-apievangelist-phrasing:
intent: Delete custom object records in bulk
effect: destructive
questions:
- Can I delete up to a thousand custom object records at once?
- How do I track a bulk deletion of object records?
instructions:
- text: Delete {object_type} records {identifiers}.
slots:
object_type: path.object_type
identifiers: requestBody.identifiers
- text: Bulk-remove records of custom object {object_type}.
slots:
object_type: path.object_type
method: generated
generated: '2026-10-01'
Discovery needs no key. Ratings and market analysis are Pro.
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.