Skip to main content
POST
Upsert object

Authorizations

Authorization
string
header
required

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

Body

application/json
type
string
required

The custom object type name. Must already exist (create it with the types endpoint) — unknown types are rejected.

Required string length: 1 - 255
externalId
string
required

Your stable identifier for this object within its type (idempotency key).

Required string length: 1 - 255
displayName
string

Human-readable label for the object.

Required string length: 1 - 255
attributes
object

Free-form custom traits. Full-replace by default — omitted keys are deleted. Pass mode:'merge' to overlay only what you send.

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

type
string
required
externalId
string
required
created
boolean
required