Skip to main content
POST
Upsert person

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Body

application/json
externalId
string
required

Your stable identifier for this person (idempotency key).

Required string length: 1 - 255
firstName
string | null

Given name.

Maximum string length: 255
lastName
string | null

Family name.

Maximum string length: 255
email
string | null

Email address.

Maximum string length: 255
phoneNumber
string | null

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

Maximum string length: 255
attributes
object

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
enum<string>
default:merge

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.

Available options:
merge,
replace

Response

Success

externalId
string
required
created
boolean
required