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 (full-replace on upsert).

Response

Success

externalId
string
required
created
boolean
required