Boom Ai

Boom Ai CDP Custom Objects API

The CDP Custom Objects API from Boom Ai — 5 operation(s) for cdp custom objects.

GitHub OpenAPI
Business capability
Customer Data Management BC-420.10

Operations 10

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

GET /api/v1/cdp/custom-objects List custom objects of one type · List objects #
Ask an LLM
“Which orders or other custom records have I stored in the CDP for a given type?”
“Can I page through all custom objects of one type, newest first?”
Tell an agent
List my {type} custom objects.
Show the latest {limit} custom objects of type {type}.
POST /api/v1/cdp/custom-objects Create or update a custom object · Upsert object #
Ask an LLM
“How do I save a single order or subscription record into the CDP?”
“Are a custom object's attributes merged or fully replaced when I upsert it again?”
Tell an agent
Upsert {type} object {externalId} with attributes {attributes}.
Save a {type} record {externalId} labeled {displayName}.
DELETE /api/v1/cdp/custom-objects/{type}/{externalId} Delete a custom object · Delete object #
Ask an LLM
“What happens to a custom object's relationships when I delete it?”
“Is deleting a custom object safe to repeat?”
Tell an agent destructive · confirm first
Delete {type} object {externalId}.
Remove the {type} record {externalId} and its links.
GET /api/v1/cdp/custom-objects/{type}/{externalId} Read one custom object · Get object #
Ask an LLM
“What attributes are stored on a specific custom object?”
“Can I look up a custom record by its type and my own external id?”
Tell an agent
Get {type} object {externalId}.
Show me the stored {type} record with id {externalId}.
POST /api/v1/cdp/custom-objects/batch Bulk upsert custom objects · Batch upsert objects #
Ask an LLM
“How many custom objects can I load into the CDP in a single request?”
“Is it safe to retry a bulk custom object import that failed partway?”
Tell an agent
Bulk upsert these custom objects: {items}.
Import this batch of up to 1000 custom records: {items}.
GET /api/v1/cdp/custom-objects/count Count objects #
GET /api/v1/cdp/custom-objects/types List custom object types · List object types #
Ask an LLM
“Which custom object types have been defined for my organization?”
“What kinds of custom records can I store in the CDP today?”
Tell an agent
List my custom object types.
Show every custom object type defined in the CDP.
POST /api/v1/cdp/custom-objects/types Define a new custom object type · Create object type #
Ask an LLM
“How do I define a new kind of custom record, like orders, before loading any?”
“Why is my custom object upsert rejected for an unknown type?”
Tell an agent
Create a custom object type {name} labeled {displayName}.
Define object type {name} ({displayName}) described as {description}.
GET /api/v1/cdp/custom-objects/types/{type} Read one custom object type · Get object type #
Ask an LLM
“What is the label and description of a particular custom object type?”
“Does a given custom object type exist yet?”
Tell an agent
Get custom object type {type}.
Show the definition of object type {type}.
POST /api/v1/cdp/custom-objects/types/{type}/search-fields Set search-result fields #

Documentation

📖
Documentation
https://docs.useboom.ai
📖
APIReference
https://docs.useboom.ai/api-reference/overview

Specifications

⚙
OpenAPI
https://artifacts.apis.io/boom-ai/openapi/boom-ai-cdp-custom-objects-api-openapi.yml

Other Resources

🔗
APIsJSON
https://artifacts.apis.io/boom-ai/apis.yml

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/boom-ai:boom-ai-cdp-custom-objects-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

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.

GitHub Google LinkedIn

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

OpenAPI Specification

boom-ai-cdp-custom-objects-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Boom CDP Custom Objects API
  version: 1.0.0
  description: 'Boom''s public REST API — one uniform surface over every platform capability. CDP: upsert people and custom objects, define object and relationship types, link and unlink relationships, and record behavioral events — one record per request or up to 1000 per request via the `/batch` endpoints. Segments: read (list, read, membership) and full authoring — discover the filterable catalog, validate a filter, create and update segments, preview match counts, and trigger evaluation. Initiatives: create and configure outreach initiatives, link WhatsApp templates, drive the lifecycle (launch, cancel, archive), and read collected-data summaries. Participants: enroll people into an active initiative, track their status, read conversation transcripts, and stop outreach. Journeys: read-only access to always-on message flows and their metrics. WhatsApp templates: list your WhatsApp numbers and list, read, and create message templates. The same capabilities are exposed as MCP tools with identical schemas.'
servers:
- url: https://www.useboom.ai
  description: Production
- url: https://dev.useboom.ai
  description: Development (sandbox — use a development organization API key)
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (78 KB total) ---
# Full source: https://artifacts.apis.io/boom-ai/openapi/boom-ai-cdp-custom-objects-api-openapi.yml