USuseboom
CDP Custom Objects

Batch upsert objects

Changed on

Upsert up to 1000 custom objects in one request. Idempotent and safely retryable. By DEFAULT each item REPLACES that object's entire attributes blob, so an item carrying only the fields you want to change DELETES every other attribute on that object. To add or change a subset across many objects, pass mode: 'merge' — it overlays the keys you send and leaves the rest untouched, with no need to read each object first. Pass createMissing: false to update only objects that already exist; anything unmatched comes back in skipped rather than being created.

post/api/v1/cdp/custom-objects/batch

Request

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

Request body

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

skippedstring[] required

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

Changes

  • 7c7a773b12ceRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      added the required property / to the response with the status