Boom Ai

Boom Ai CDP Relationships API

The CDP Relationships API from Boom Ai — 4 operation(s) for cdp relationships.

GitHub OpenAPI

Operations 7

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/relationship-types List relationship types · List relationship types #
Ask an LLM
“Which relationship types are defined, so I know how people and objects can be linked?”
“What link shapes are valid before I connect a person to an order?”
Tell an agent
List my relationship types.
Show every valid relationship type in the CDP.
POST /api/v1/cdp/relationship-types Register a relationship type · Register relationship type #
Ask an LLM
“How do I define that a person places orders, or that an order has line items?”
“Can I set the cardinality of a relationship, such as one-to-many?”
Tell an agent
Register a {kind} relationship type with role {role} to object type {customObjectType}.
Register role {role} linking parent {parentCustomObjectType} to child {childCustomObjectType} as {kind} with cardinality {cardinality}.
GET /api/v1/cdp/relationship-types/{relationshipTypeId} Read one relationship type · Get relationship type #
Ask an LLM
“What role and object types does a specific relationship type connect?”
“Can I check the cardinality of one relationship type by its id?”
Tell an agent
Get relationship type {relationshipTypeId}.
Show the definition of relationship type {relationshipTypeId}.
GET /api/v1/cdp/relationships List relationship links for a person or object · List relationships #
Ask an LLM
“Which orders or other objects is a given person linked to?”
“Can I include links that were removed when listing relationships?”
Tell an agent
List the {kind} links for person {personExternalId}.
Show {kind} relationships anchored on {customObjectType} {customObjectExternalId}.
POST /api/v1/cdp/relationships/batch Bulk link or unlink relationships · Batch link / unlink #
Ask an LLM
“Can I link and unlink many relationships in one request?”
“What is the maximum number of relationship changes per bulk call?”
Tell an agent
Apply these relationship links and unlinks in bulk: {items}.
Batch-process up to 1000 relationship changes: {items}.

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-relationships-api-openapi.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-relationships-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-relationships-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Boom CDP Relationships 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 (68 KB total) ---
# Full source: https://artifacts.apis.io/boom-ai/openapi/boom-ai-cdp-relationships-api-openapi.yml