Create a collection qualifier

Last update: 2023-10-18
  • Created for:
  • Experienced

You can create a collection qualifier (previously known as “tag”) by making a POST request to the Offer Library API, while providing your container ID.

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/schema-instance+json; version=1; schema=";version=0.1"

API format

Parameter Description Example
{ENDPOINT_PATH} The endpoint path for repository APIs.
{CONTAINER_ID} The container where the collection qualifiers are located. e0bd8463-0913-4ca1-bd84-6309134ca1f6


curl -X POST \
  '' \
  -H 'Accept: application/vnd.adobe.platform.xcore.xdm.receipt+json; version=1' \
  -H 'Content-Type: application/schema-instance+json; version=1; schema=";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 '{
        "xdm:name": "Holiday sales and promotions"


A successful response returns information on the newly created collection qualifier, including its unique instance ID and placement @id. You can use the instance ID in later steps to update or delete your collection qualifier. You can use your unique collection qualifier @id in later tutorials to create collections and personalized offers.

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

On this page