Boom Ai CDP Sensitive fields API
The CDP Sensitive fields API from Boom Ai — 1 operation(s) for cdp sensitive fields.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/boom-ai:boom-ai-cdp-sensitive-fields-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Boom CDP Sensitive fields 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:
- name: CDP Sensitive fields
paths:
/api/v1/cdp/sensitive-fields:
get:
operationId: cdp_sensitive_fields_get
summary: List sensitive fields
description: 'List the fields your organization marked sensitive: contact fields, People attributes and custom object attributes. A sensitive value is hidden from AI agents and from teammates without access (it reads `[redacted]`); it stays stored and keeps working in segments and messages. Returns field names only, never values.'
tags:
- CDP Sensitive fields
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
builtIns:
type: array
items:
type: string
enum:
- EMAIL
- PHONE_NUMBER
- FIRST_NAME
- LAST_NAME
description: A contact field every person has. `externalId` cannot be hidden.
description: Contact fields marked sensitive.
people:
type: array
items:
type: string
description: People attribute keys marked sensitive.
customObjects:
type: array
items:
type: object
properties:
type:
type: string
description: The custom object type name.
keys:
type: array
items:
type: string
required:
- type
- keys
additionalProperties: false
description: Custom object attribute keys marked sensitive, per type.
required:
- builtIns
- people
- customObjects
additionalProperties: false
'400':
description: Validation failed or the request cannot proceed.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'401':
description: Missing, malformed, or revoked API key.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'404':
description: The resource does not exist in this organization.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'409':
description: Conflicts with the current state (duplicates, wrong lifecycle state).
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'422':
description: The request is well-formed but semantically invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'429':
description: Rate limit exceeded — retry after `Retry-After`.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'500':
description: Internal server error.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'503':
description: Transient error — retry with a narrower request.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
post:
operationId: cdp_sensitive_fields_set
summary: Mark fields sensitive
description: 'Mark fields sensitive (or, over the REST API only, visible again). A sensitive value is hidden from AI agents and from teammates without access; it stays stored and keeps working in segments and messages. Applies every change or none: an unknown field fails the whole call. Keys must already exist in the attribute catalog. Over MCP only `isSensitive: true` is accepted — making a field visible again is refused with `sensitive_unmark_forbidden`; use Settings › Sensitive data or the REST API.'
tags:
- CDP Sensitive fields
requestBody:
required: true
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
changes:
description: 'The fields to change, as an array. Each item names one field by `scope`: `built_in` with `field`, `people` with `key`, or `custom_object` with `type` and `key`.'
minItems: 1
maxItems: 100
type: array
items:
oneOf:
- type: object
properties:
scope:
type: string
const: built_in
field:
type: string
enum:
- EMAIL
- PHONE_NUMBER
- FIRST_NAME
- LAST_NAME
description: A contact field every person has. `externalId` cannot be hidden.
isSensitive:
type: boolean
required:
- scope
- field
- isSensitive
- type: object
properties:
scope:
type: string
const: people
key:
type: string
minLength: 1
maxLength: 255
description: The People attribute key.
isSensitive:
type: boolean
required:
- scope
- key
- isSensitive
- type: object
properties:
scope:
type: string
const: custom_object
type:
type: string
minLength: 1
maxLength: 255
description: The custom object type name.
key:
type: string
minLength: 1
maxLength: 255
description: The attribute key in that type's catalog.
isSensitive:
type: boolean
required:
- scope
- type
- key
- isSensitive
required:
- changes
responses:
'200':
description: Success
content:
application/json:
schema:
$schema: https://json-schema.org/draft/2020-12/schema
type: object
properties:
applied:
type: array
items:
type: object
properties:
scope:
type: string
enum:
- built_in
- people
- custom_object
field:
type: string
enum:
- EMAIL
- PHONE_NUMBER
- FIRST_NAME
- LAST_NAME
description: A contact field every person has. `externalId` cannot be hidden.
type:
type: string
key:
type: string
isSensitive:
type: boolean
changed:
type: boolean
description: False when the field already had this value.
required:
- scope
- isSensitive
- changed
additionalProperties: false
required:
- applied
additionalProperties: false
'400':
description: Validation failed or the request cannot proceed.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'401':
description: Missing, malformed, or revoked API key.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'404':
description: The resource does not exist in this organization.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'409':
description: Conflicts with the current state (duplicates, wrong lifecycle state).
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'422':
description: The request is well-formed but semantically invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'429':
description: Rate limit exceeded — retry after `Retry-After`.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'500':
description: Internal server error.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
'503':
description: Transient error — retry with a narrower request.
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: Stable machine-readable error code (snake_case).
message:
type: string
required:
- code
- message
required:
- error
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: 'Organization API key, sent as `Authorization: Bearer boom_org_...`.'
x-provenance:
method: harvested
publisher: Boom Ai
source: https://docs.useboom.ai/api-reference/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)