Skip to main content
POST
Batch upsert objects

Authorizations

Authorization
string
header
required

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

Body

application/json
items
object[]
required

Custom objects to upsert.

Required array length: 1 - 1000 elements
mode
enum<string>
default:replace

How attributes is applied. 'replace' (default) swaps the whole blob — any stored attribute you leave out is DELETED. 'merge' overlays the keys you send onto the stored ones and leaves the rest untouched, which is what you want when adding or changing a subset.

Available options:
replace,
merge
createMissing
boolean
default:true

When false, objects that do not already exist are skipped and reported in skipped instead of being created. Use it when working from a list that may not match, so a bad id enriches nothing rather than inventing an object.

Response

Success

summary
object
required
errors
object[]
required
skipped
string[]
required

externalIds not written because createMissing was false and no such object exists.