USuseboom
CDP Custom Objects

Upsert object

Changed on

Create or update a custom object by type and external id. The type must already exist. By default attributes is REPLACED wholesale — pass mode: 'merge' to add or change a subset without deleting the rest, and createMissing: false to update only when the object already exists.

post/api/v1/cdp/custom-objects

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Request body

typestring required

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

externalIdstring required

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

displayNamestring

Human-readable label for the object.

attributesobject

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

mode'replace' | 'merge'

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.

createMissingboolean

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

typestring required
externalIdstring required
createdboolean required

Changes

  • 7c7a773b12ceRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property