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

Response

Success

type
string
required
externalId
string
required
created
boolean
required