USuseboom
CDP People

Upsert person

Changed on

Create or update a person by external id. Attributes are merged into the stored ones by default (omitted keys kept, null removes a key); pass mode:'replace' to swap the whole set.

post/api/v1/cdp/people

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Request body

externalIdstring required

Your stable identifier for this person (idempotency key). Cannot start with "boom:", which is reserved for people Boom creates.

firstNamestring nullable

Given name.

lastNamestring nullable

Family name.

emailstring nullable

Email address.

phoneNumberstring nullable

Phone number in E.164 format (e.g. +5215555555555).

attributesobject

Free-form custom traits. Merged into the stored ones by default: keys you omit are kept, and a key sent as null is removed. Pass mode:'replace' to swap the whole set.

mode'merge' | 'replace'

How attributes and the profile fields are applied. 'merge' (default) overlays the attributes you send onto the stored ones: omitted keys are kept, a key sent as null is removed, and an omitted or null profile field (firstName, lastName, email, phoneNumber) keeps its stored value. 'replace' swaps the whole attribute set (any key you leave out is DELETED) and writes every profile field as sent, so an omitted one is cleared.

Response

Success

externalIdstring required
createdboolean required

Changes