Update a collection qualifier update-collection-qualifier

You can modify or update a collection qualifier (previously known as “tag”) 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 accept-and-content-type-headers

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

API format

PATCH /{ENDPOINT_PATH}/tags/{ID}

Request

curl -X PATCH 'https://platform.adobe.io/data/core/dps/tags/tag1234' \
-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 tag"
    },
    {
        "op": "replace",
        "path": "/description",
        "value": "Updated tag description"
    }
]'

Response

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

{
    "id": "{ID}",
    "sandboxId": "{SANDBOX_ID}",
    "etag": 2,
    "createdDate": "2023-09-07T12:36:26.602Z",
    "lastModifiedDate": "2023-09-07T12:36:26.602Z",
    "createdBy": "{CREATED_BY}",
    "lastModifiedBy": "{MODIFIED_BY}",
    "createdByClientId": "{CREATED_CLIENT_ID}",
    "lastModifiedByClientId": "{MODIFIED_CLIENT_ID}"
}