Update records

post

https://api.bloomreach.com/api/cde/v1/workspaces/{workspace_id}/item-collections/{collection_name}/item-types/{item_type}/records

Updates records within a specific item type using a patch-based approach. Supports both product-level and variant-level updates. This is an asynchronous operation that returns a job reference for tracking.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workspace_id

uuid

required

length between 36 and 36

Unique identifier for the workspace

collection_name

string

required

length ≤ 128

Name of the collection

item_type

string

required

length between 1 and 64

Type of the item. Currently only 'product' is supported.

Query Params

update_mode

string

length ≤ 32

Defaults to delta

Controls how updates are applied: 'delta' (default) makes changes to existing records while preserving others, 'full' removes all existing records before applying the patch. When not supplied, 'delta' mode is used. Avoid sending one request per source-system event. Buffer frequent changes and send them as micro-batches, since a single delta update can carry many patch operations. See Patch processing and jobs.

on_success_trigger

array of strings

length ≤ 10

Specifies actions to perform on successful completion of the operation. This parameter can be repeated to specify multiple triggers. These override any configured settings for the specific on success actions. For configuration updates, supported values include 'update-items' and 'update-destination-items'. For update-records jobs, supported values include 'update-items' and 'update-destination-items'. For update-items jobs, supported values include 'update-destination-items'. This is an open enumeration that may be extended with additional values.

on_success_trigger

family

string

length ≤ 64

Defaults to main

The attribute family to include alongside system families. Defaults to 'main' if not specified.

Body Params

Data for updating records. Can be either patch operations in JSON or JSONLines format, or references to files in JSONLines format previously uploaded using the Get Upload URLs API.

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Responses

202Successfully acknowledged the update records request

400Standard error response format for normal application-level failures. In rare edge cases, such as malformed HTTP requests rejected before normal request handling completes, the API may return a more generic fallback error payload.

401Standard error response format for normal application-level failures. In rare edge cases, such as malformed HTTP requests rejected before normal request handling completes, the API may return a more generic fallback error payload.

403Standard error response format for normal application-level failures. In rare edge cases, such as malformed HTTP requests rejected before normal request handling completes, the API may return a more generic fallback error payload.

404Standard error response format for normal application-level failures. In rare edge cases, such as malformed HTTP requests rejected before normal request handling completes, the API may return a more generic fallback error payload.

429Response format for rate limiting errors (429)

500Standard error response format for normal application-level failures. In rare edge cases, such as malformed HTTP requests rejected before normal request handling completes, the API may return a more generic fallback error payload.