Concepts
People
Individuals, keyed by your own
externalId. Arbitrary data lives in a
free-form attributes object.Custom objects
Typed records (an
order, a loan, …) keyed by (type, externalId).
Types are defined per organization.Attributes
Free-form key/value data on people and objects. New keys are
auto-registered in your attribute catalog so they appear in Segments.
Relationships
Links between a person and a custom object (e.g. a customer who
placed an order).How it works
- Every request is authenticated with an organization API key sent as a Bearer token. The organization is derived from the key — you never pass an org id.
- Each request processes one record (there are no batch endpoints yet).
- Writes are upserts: the same
externalIdtwice updates rather than duplicates.attributesare fully replaced on update — always send the complete set.
The base URL shown throughout these docs is
https://app.useboom.ai.
Confirm your actual API domain in the dashboard.