Unified tags endpoint
https://experience.adobe.io
.Tags are a capability that let you manage metadata taxonomies to classify business objects for easier discovery and categorization. You subsequently can organize these tags into further groups by adding them to tag categories.
This guide provides information to help you better understand tags and tag categories and includes sample API calls for performing basic actions using the API.
Getting started
The endpoints used in this guide are part of the Adobe Experience Platform APIs. Before continuing, please review the getting started guide for important information that you need to know in order to successfully make calls to the API, including required headers and how to read example API calls
Glossary
The following glossary highlights the difference between a tag and a tag category.
- Tag: A tag allows you to manage the metadata taxonomy for business objects, allowing you to classify these objects for easier discovery and categorization.
- Uncategorized tag: An uncategorized tag is a tag that does not belong to a tag category. By default, created tags will be uncategorized.
- Tag category: A tag category allows you to group your tags into meaningful sets, allowing you to provide more context to the tag’s purpose.
Retrieve a list of tag categories get-tag-categories
You can retrieve a list of tag categories that belong to your organization by making a GET request to the /tagCategory
endpoint.
API format
GET /tagCategory
GET /tagCategory?{QUERY_PARAMETERS}
The following optional query parameters can be used when retrieving tag categories.
start
start=a
limit
limit=20
property
The attribute you want to filter by when retrieving tag categories. Supported values include: <ul≥
name
: The name of the tag category.
property=name==category
sortBy
name
, createdAt
, and modifiedAt
.sortBy=name
sortOrder
asc
and desc
.sortOrder=asc
Request
code language-shell |
---|
|
Response
A successful response returns HTTP status 200 with a list of all the tag categories for your organization.
code language-json |
---|
|
Create a new tag category create-tag-category
You can create a new tag category by making a POST request to the /tagCategory
endpoint.
API format
POST /tagCategory
Request
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 | |
---|---|
Property | Description |
name |
The name of the tag category you want to create. |
description |
A description of the tag category you want to create. |
Response
A sample response returns HTTP status 200 with details of your newly created tag category.
code language-json |
---|
|
Retrieve a specific tag category get-tag-category
You can retrieve a specific tag category that belongs to your organization by making a GET request to the /tagCategory
endpoint and specifying the tag category’s ID.
API format
GET /tagCategory/{TAG_CATEGORY_ID}
{TAG_CATEGORY_ID}
Request
code language-shell |
---|
|
Response
A successful response returns HTTP status 200 with details of the specified tag category.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
---|---|
Property | Description |
id |
The ID of the requested tag category. |
name |
The name of the requested tag category. |
description |
The description of the requested tag category. |
createdBy |
The ID of the user who created the tag category. |
createdAt |
The timestamp of when the tag category was created. |
modifiedBy |
The ID of the user who last updated the tag category. |
modifiedAt |
The timestamp of when the tag category was last updated. |
tagCount |
The number of tags that belong to the tag category. |
Update a specific tag category update-tag-category
You can update details of a specific tag category that belongs to your organization by making a PATCH request to the /tagCategory
endpoint and specifying the tag category’s ID.
API format
PATCH /tagCategory/{TAG_CATEGORY_ID}
{TAG_CATEGORY_ID}
Request
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
---|---|
Parameter | Description |
op |
The operation that is completed. To update a specific tag category, set this value to replace . |
path |
The path of the field that will be updated. Supported values include name and description . |
value |
The updated value of the field you want to update. |
from |
The original value of the field you want to update. |
Response
A successful response HTTP status 200 with information about your newly updated tag category.
code language-json |
---|
|
Delete a specific tag category delete-tag-category
You can delete a specific tag category that belongs to your organization by making a DELETE request to the /tagCategory
endpoint and specifying the tag category’s ID.
API format
DELETE /tagCategory/{TAG_CATEGORY_ID}
{TAG_CATEGORY_ID}
Request
code language-shell |
---|
|
Response
A successful response returns HTTP status 200 along with an empty response.
Retrieve a list of tags get-tags
You can retrieve a list of tags that belong to your organization by making a GET request to the /tags
endpoint and the ID of the tag category.
API format
GET /tags
GET /tags?{QUERY_PARAMETERS}
The following optional query parameters can be used when retrieving tags.
start
start=a
limit
limit=20
property
The attribute you want to filter by when retrieving tags. Supported values include:
name
: The name of the tag.archived
: Whether or not the tags are archived or unarchived. You can set this value to eithertrue
orfalse
.tagCategoryId
: The ID of the tag category the tag belongs to.
property=name==TestTag
property=archived==false
property=tagCategoryId==e2b7c656-067b-4413-a366-adde0401df50
sortBy
name
, createdAt
, and modifiedAt
.sortBy=name
sortOrder
asc
and desc
.sortOrder=asc
Request
code language-shell |
---|
|
Response
A successful response returns HTTP status 200 with details of the tags belonging to that tag category.
code language-json |
---|
|
Create a new tag create-tag
You can create a new tag by making a POST request to the /tags
endpoint.
API format
POST /tags
Request
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 | |
---|---|
Property | Description |
name |
Required. The name of the tag you want to create. |
tagCategoryId |
Optional. The ID of the tag category that you want the tag to belong to. If not specified, the tag will be created as part of the Uncategorized category. |
Response
A successful response returns HTTP status 201 with details of your newly created tag.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 | |
---|---|
Parameter | Description |
name |
The name of the newly created tag. |
id |
The ID of the newly created tag. |
org |
The ID of the organization the tag belongs to. |
createdAt |
The timestamp of when the tag was created. |
createdBy |
The ID of the user who created the tag. |
modifiedAt |
The timestamp of when the tag was last updated. |
modifiedBy |
The ID of the user who last updated the tag. |
tagCategoryId |
The ID of the tag category that the tag belongs to. |
tagCategoryName |
The name of the tag category that the tag belongs to. |
Retrieve a specific tag get-tag
You can retrieve a specific tag that belongs to your organization by making a GET request to the /tags
endpoint and specifying the ID of the tag you want to retrieve.
API format
GET /tags/{TAG_ID}
{TAG_ID}
Request
code language-shell |
---|
|
Response
A successful response returns HTTP status 200 with details of the specified tag.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 | |
---|---|
Parameter | Description |
name |
The name of the tag you retrieved. |
id |
The ID of the tag you retrieved. |
org |
The ID of the organization the tag belongs to. |
createdAt |
The timestamp of when the tag was created. |
createdBy |
The ID of the user who created the tag. |
modifiedAt |
The timestamp of when the tag was last updated. |
modifiedBy |
The ID of the user who last updated the tag. |
tagCategoryId |
The ID of the tag category that the tag belongs to. |
tagCategoryName |
The name of the tag category that the tag belongs to. |
archived |
The archival status of the tag. If set to true , it means that the tag is archived. |
Validate tags validate-tags
You can validate if tags exist by making a POST request to the /tags/validate
endpoint.
API format
POST /tags/validate
Request
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 | |
---|---|
Property | Description |
ids |
An array that contains a list of tag IDs you want to validate. |
entity |
The entity that is requesting the validation. You can use the {API_KEY} value for this parameter. |
Response
A successful response returns HTTP status 200 with information about which tags are valid and invalid.
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 | |
---|---|
Property | Description |
invalidTags |
An array that contains a list of the invalid tag IDs. |
validTags |
An array that contains a list of the valid tag IDs. |
Update a specific tag update-tag
You can update a specified tag by making a PATCH request to the /tags
endpoint and providing the ID of the tag you want to update.
API format
PATCH /tags/{TAG_ID}
{TAG_ID}
Request
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
---|---|
Property | Description |
op |
The operation that needs to be done. In this use case, it’ll always be set to replace . |
path |
The path of the field that will be updated. Supported values include name , archived , and tagCategoryId . |
value |
The updated value of the field you want to update. |
from |
The original value of the field you want to update. |
Response
A successful response returns HTTP status 200 with details of the newly updated tag.
code language-json |
---|
|
Delete a specific tag delete-tag
You can delete a specific tag by making a DELETE tag to the /tags
endpoint and specifying the ID of the tag that you want to delete.
API format
DELETE /tags/{TAG_ID}
{TAG_ID}
Request
code language-shell |
---|
|
Response
A successful response returns HTTP status 200 along with an empty response.
Next steps
After reading this guide, you have a better understanding of how to create, manage, and delete tags and tag categories using the Adobe Experience Platform APIs. For more information on managing tags using the UI, please read the managing tags guide. For more information on managing tag categories using the UI, please read the tag categories guide.