Update a collection qualifier

Last update: 2024-01-18
  • Created for:
  • Experienced

You can modify or update a collection qualifier (previously known as “tag”) in your container 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.

Accept and Content-Type headers

The following table shows the valid values which comprise the Content-Type and Accept fields in the request header:

Header name Value
Accept application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1
Content-Type application/vnd.adobe.platform.xcore.patch.hal+json; version=1; schema="https://ns.adobe.com/experience/offer-management/tag;version=0.1"

API format


| Parameter | Description | Example |
| {ENDPOINT_PATH} | The endpoint path for repository APIs. | https://platform.adobe.io/data/core/xcore/ |
| {CONTAINER_ID} | The container where the tags are located. | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
| {INSTANCE_ID} | The instance id of the tag you wish to update. | d48fd160-13dc-11eb-bc55-c11be7252432 |


curl -X PATCH \
  'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/d48fd160-13dc-11eb-bc55-c11be7252432' \
  -H 'Accept: application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1' \
  -H 'Content-Type: application/vnd.adobe.platform.xcore.patch.hal+json; version=1; schema="https://ns.adobe.com/experience/offer-management/tag;version=0.1"' \
  -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": "/_instance/xdm:name",
          "value": "Sales and promotions for the holidays"
Parameter Description
op The operation call used to define the action needed to update the connection. Operations include: add, replace, remove, copy and test.
path The path of the parameter to be updated.
value The new value you want to update your parameter with.


A successful response returns the updated details of the collection qualifier, including its unique instance ID and collection qualifier @id.

    "instanceId": "d48fd160-13dc-11eb-bc55-c11be7252432",
    "@id": "xcore:tag:124e147572cd7866",
    "repo:etag": 2,
    "repo:createdDate": "2020-10-21T20:34:34.486296Z",
    "repo:lastModifiedDate": "2020-10-21T20:36:31.782607Z",
    "repo:createdBy": "{CREATED_BY}",
    "repo:lastModifiedBy": "{MODIFIED_BY}",
    "repo:createdByClientId": "{CREATED_CLIENT_ID}",
    "repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"

On this page