DocumentationJourney OptimizerJourney Optimizer Guide

Update an item collection update-item-collection

Last update: Fri Oct 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Developer

You can modify or update a item collection by making a PATCH request to the Offer Library API.

For more information on JSON Patch, including available operations, see the official JSON Patch documentation.

API format

PATCH /{ENDPOINT_PATH}/item-collections/{ID}
Parameter
Description
Example
{ENDPOINT_PATH}
The endpoint path for persistence APIs.
https://platform.adobe.io/data/core/dps
{ID}
The id of the entity you wish to update.
itemCollections1234

Request


curl -X PATCH 'https://platform.adobe.io/data/core/dps/item-collections/itemCollections1234' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer  {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '[
    {
        "op": "replace",
        "path": "/name",
        "value": "Updated item collection"
    },
    {
        "op": "replace",
        "path": "/description",
        "value": "Updated item collection description"
    }
]'
Parameter
Description
value
The new value you want to update your parameter with.
path
The path of the parameter to be updated.
op
The operation call used to define the action needed to update the connection. Operations include: add, replace, remove, copy and test.

Response

A successful response returns the updated details of the item collection, including the id.

{
    "etag": 2,
    "createdBy": "{CREATED_BY}",
    "lastModifiedBy": "{MODIFIED_BY}",
    "id": "{ID}",
    "sandboxId": "{SANDBOX_ID}",
    "createdDate": "2023-05-31T15:09:11.771Z",
    "lastModifiedDate": "2023-05-31T15:09:11.771Z",
    "createdByClientId": "{CREATED_CLIENT_ID}",
    "lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}
recommendation-more-help
b22c9c5d-9208-48f4-b874-1cefb8df4d76