Skip to main content
POST
Batch upsert people

Authorizations

Authorization
string
header
required

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

Body

application/json
items
object[]
required

People to upsert.

Required array length: 1 - 1000 elements
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

summary
object
required
errors
object[]
required