Get Credentials

Get credentials

After signing in, you can create credentials that can be used to call the Platform APIs.

Unified Tags API (1.0)

Download OpenAPI specification:Download

Use the Unified Tags API to create folders, tags, and tag categories, which let you better organize your business objects.

(NEW) Interactive API documentation

You can now interact with the Experience Platform API endpoints directly from this API reference page. Get your authentication credentials and use the Try it functionality in the right rail. Note that by using this functionality, you are making real API calls. Keep this in mind when you interact with production sandboxes.

Folders

Folders are a capability that let you better organize your business objects for easier navigability and categorization.

Create a folder

Request
path Parameters
FOLDER_TYPE
required
string

The type of folder you're retrieving. Supported values include segment and dataset.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Request Body schema: */*
required

The request body to create the folder.

name
string

The name of the folder you want to create.

parentId
string

The parent ID of the folder you want to create.

Responses
200

Created

post/unifiedfolders/folders/{FOLDER_TYPE}
Response samples
application/json
{
  • "id": "83f8287c-767b-4106-b271-257282fd170e",
  • "name": "SampleFolder",
  • "noun": "dataset",
  • "imsOrg": "{ORG_ID}",
  • "sandboxId": "{SANDBOX_ID}",
  • "sandboxName": "prod",
  • "createdBy": "{USER_ID}",
  • "createdAt": "2023-10-01T08:47:06.192+00:00",
  • "modifiedBy": "{USER_ID}",
  • "modifiedAt": "2023-10-01T08:47:06.192+00:00",
  • "status": "IN_USE",
  • "_links": {
    }
}

Retrieve a specified folder

Request
path Parameters
FOLDER_TYPE
required
string

The type of folder you're retrieving. Supported values include segment and dataset.

FOLDER_ID
required
string

The ID of the folder.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

get/unifiedfolders/folders/{FOLDER_TYPE}/{FOLDER_ID}
Response samples
application/json
{
  • "id": "83f8287c-767b-4106-b271-257282fd170e",
  • "name": "SampleFolder",
  • "noun": "dataset",
  • "imsOrg": "{ORG_ID}",
  • "sandboxId": "{SANDBOX_ID}",
  • "sandboxName": "prod",
  • "createdBy": "{USER_ID}",
  • "createdAt": "2023-10-01T08:47:06.192+00:00",
  • "modifiedBy": "{USER_ID}",
  • "modifiedAt": "2023-10-01T08:47:06.192+00:00",
  • "status": "IN_USE",
  • "_links": {
    }
}

Update a specific folder

Request
path Parameters
FOLDER_TYPE
required
string

The type of folder you're retrieving. Supported values include segment and dataset.

FOLDER_ID
required
string

The ID of the folder.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Request Body schema: */*
required

The request body to update the folder.

Array
op
required
string

The type of operation for the PATCH operation. Only replace is supported.

Value: "replace"
path
required
string

The path for the field that needs to be updated.

value
required
string

The updated value for the field that needs to be updated.

Responses
200

Success

patch/unifiedfolders/folders/{FOLDER_TYPE}/{FOLDER_ID}
Response samples
application/json
{
  • "id": "83f8287c-767b-4106-b271-257282fd170e",
  • "name": "RenamedSampleFolder",
  • "noun": "dataset",
  • "imsOrg": "{ORG_ID}",
  • "sandboxId": "{SANDBOX_ID}",
  • "sandboxName": "prod",
  • "createdBy": "{USER_ID}",
  • "createdAt": "2023-10-01T08:47:06.192+00:00",
  • "modifiedBy": "{USER_ID}",
  • "modifiedAt": "2023-10-01T08:47:06.192+00:00",
  • "status": "IN_USE",
  • "_links": {
    }
}

Delete a specific folder

Request
path Parameters
FOLDER_TYPE
required
string

The type of folder you're retrieving. Supported values include segment and dataset.

FOLDER_ID
required
string

The ID of the folder.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

delete/unifiedfolders/folders/{FOLDER_TYPE}/{FOLDER_ID}
Response samples
application/json
{
  • "message": "delete request accepted successfully"
}

Retrieve a folder's subfolders

Request
path Parameters
FOLDER_TYPE
required
string

The type of folder you're retrieving. Supported values include segment and dataset.

FOLDER_ID
required
string

The ID of the folder.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

get/unifiedfolders/folders/{FOLDER_TYPE}/{FOLDER_ID}/subfolders
Response samples
application/json
{
  • "id": "c626b4f7-223b-4486-8900-00c266e31dd1",
  • "name": "ParentFolder",
  • "noun": "dataset",
  • "imsOrg": "{IMS_ORG}",
  • "sandboxId": "{SANDBOX_ID}",
  • "sandboxName": "prod",
  • "createdBy": "null",
  • "createdAt": "2023-01-12T03:31:00.118+00:00",
  • "modifiedBy": "null",
  • "modifiedAt": "2023-01-13T05:47:06.718+00:00",
  • "_links": null,
  • "children": [
    ]
}

Validate a specific folder

Use this endpoint to validate if a folder is eligible to have objects in it.

Request
path Parameters
FOLDER_TYPE
required
string

The type of folder you're retrieving. Supported values include segment and dataset.

FOLDER_ID
required
string

The ID of the folder.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-sandbox-name
required
string

All resources in Experience Platform are isolated to specific virtual sandboxes. Requests to Platform APIs require a header that specifies the name of the sandbox in which the operation will take place. See the sandboxes overview for more information.

Responses
200

Success

get/unifiedfolders/folders/{FOLDER_TYPE}/{FOLDER_ID}/validate
Response samples
application/json
{
  • "id": "83f8287c-767b-4106-b271-257282fd170e",
  • "name": "SampleFolder",
  • "noun": "dataset",
  • "imsOrg": "{ORG_ID}",
  • "sandboxId": "{SANDBOX_ID}",
  • "sandboxName": "prod",
  • "createdBy": "{USER_ID}",
  • "createdAt": "2023-10-01T08:47:06.192+00:00",
  • "modifiedBy": "{USER_ID}",
  • "modifiedAt": "2023-10-01T08:47:06.192+00:00",
  • "status": "IN_USE",
  • "_links": {
    }
}

Tags

Tags let you manage the metadata taxonomy for business objects, allowing you to classify these objects for easier discovery and categorization.

Retrieve tags

Request
query Parameters
start
string

The location where the list of results starts from. You can use this to indicate the starting index for pagination of results.

limit
string

The number of tags you want displayed per page.

property
string

The attribute you want to filter by when retrieving tags. Supported values include name, archived, and tagCategoryId.

sortBy
string

The attribute that is used to determine the sort order for the tags. Supported values include name, createdAt, and modifiedAt.

sortOrder
string

The direction in which the tags are sorted by. Supported values include asc and desc.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Responses
200

Success

get/unifiedtags/tags
Response samples
application/json
{
  • "_page": {
    }
}

Create a new tag

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Request Body schema: */*
required

The request body to create a tag.

name
required
string

The name that you want to give the tag.

tagCategoryId
string

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.

Responses
201

Created

post/unifiedtags/tags
Response samples
application/json
{
  • "archived": false,
  • "createdAt": 1705624523000,
  • "createdBy": "{USER_ID}",
  • "id": "8af14b1e-f267-44ad-b94c-9ac70274e3d5",
  • "modifiedAt": "1705624523000",
  • "modifiedBy": "{USER_ID}",
  • "name": "sample-tag",
  • "org": "{ORG_ID}",
  • "tagCategoryId": "e2b7c656-067b-4413-a366-adde0401df50",
  • "tagCategoryName": "Test Category"
}

Retrieve a tag

Request
path Parameters
TAG_ID
required
string

The ID of the tag.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Responses
200

Success

get/unifiedtags/tags/{TAG_ID}
Response samples
application/json
{
  • "archived": false,
  • "createdAt": 1705624523000,
  • "createdBy": "{USER_ID}",
  • "id": "8af14b1e-f267-44ad-b94c-9ac70274e3d5",
  • "modifiedAt": "1705624523000",
  • "modifiedBy": "{USER_ID}",
  • "name": "sample-tag",
  • "org": "{ORG_ID}",
  • "tagCategoryId": "e2b7c656-067b-4413-a366-adde0401df50",
  • "tagCategoryName": "Test Category"
}

Update a tag

Request
path Parameters
TAG_ID
required
string

The ID of the tag.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Request Body schema: */*
required

The request body to update the tag.

op
string

The operation for the PATCH call. Only replace is supported.

path
string

The path of the field you want to update. Supported values include /name, archived, and /tagCategoryId.

value
string

The updated value of the field you want to update.

from
string

The original value of the field you want to update.

Responses
200

Success

patch/unifiedtags/tags/{TAG_ID}
Response samples
application/json
{
  • "archived": false,
  • "createdAt": 1705624523000,
  • "createdBy": "{USER_ID}",
  • "id": "8af14b1e-f267-44ad-b94c-9ac70274e3d5",
  • "modifiedAt": "1705624523000",
  • "modifiedBy": "{USER_ID}",
  • "name": "updatedSampleTag",
  • "org": "{ORG_ID}",
  • "tagCategoryId": "e2b7c656-067b-4413-a366-adde0401df50",
  • "tagCategoryName": "Test Category"
}

Delete a tag

Request
path Parameters
TAG_ID
required
string

The ID of the tag.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Responses
200

Success

delete/unifiedtags/tags/{TAG_ID}

Validate tags

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Request Body schema: */*

The request body to validate the tags.

ids
Array of strings

The list of IDs that you're trying to validate.

entity
string

The entity that is requesting the validation of the tags.

Responses
200

Success

post/unifiedtags/tags/validate
Response samples
application/json
{
  • "invalidTags": [
    ],
  • "validTags": [
    ]
}

Tag categories

Tag categories let you organize your tags into meaningful sets, allowing you to provide more context to the tag's purpose.

List tag categories

Request
query Parameters
start
string

The location where the list of results starts from. You can use this to indicate the starting index for pagination of results.

limit
string

The maximum number of tag categories you want retrieved per page.

property
string

The attribute you want to filter by when retrieving tag categories.

sortBy
string

The order in which the tag categories are sorted by. Supported values include name, createdAt, and modifiedAt.

sortOrder
string

The direction in which the tag categories are sorted by. Supported values include asc and desc.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Responses
200

Success

get/unifiedtags/tagCategory
Response samples
application/json
{
  • "_page": {
    },
  • "tags": [
    ]
}

Create a new tag category

Request
header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Request Body schema: */*
required

The request body to create the tag category.

name
string

The name for the tag category you want to create.

description
string

The description of the tag category you want to create.

Responses
200

Success

post/unifiedtags/tagCategory
Response samples
application/json
{
  • "id": "e2b7c656-067b-4413-a366-adde0401df50",
  • "name": "Sample Tag Category",
  • "description": "Sample tag category description",
  • "org": "{ORG_ID}",
  • "createdBy": "{USER_ID}",
  • "createdAt": "1661752268000",
  • "modifiedBy": "{USER_ID}",
  • "modifiedAt": "1661752268000",
  • "tagCount": 0
}

Retrieve a specific tag category

Request
path Parameters
TAG_CATEGORY_ID
required
string

The ID of the tag category.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Responses
200

Success

get/unifiedtags/tagCategory/{TAG_CATEGORY_ID}
Response samples
application/json
{
  • "id": "e2b7c656-067b-4413-a366-adde0401df50",
  • "name": "Sample Tag Category",
  • "description": "Sample tag category description",
  • "org": "{ORG_ID}",
  • "createdBy": "{USER_ID}",
  • "createdAt": "1661752268000",
  • "modifiedBy": "{USER_ID}",
  • "modifiedAt": "1661752268000",
  • "tagCount": 0
}

Update a specific tag category

Important: Only the system administrator and the product administrator can use this API call.

Request
path Parameters
TAG_CATEGORY_ID
required
string

The ID of the tag category.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Request Body schema: */*

The request body to update the tag category.

Array
op
string

The operation for the PATCH call. Only replace is supported.

path
string

The path of the field you want to update. Supported values include /name and /description.

value
string

The updated value of the field you want to update.

from
string

The original value of the field you want to update.

Responses
200

Success

patch/unifiedtags/tagCategory/{TAG_CATEGORY_ID}
Response samples
application/json
{
  • "id": "e2b7c656-067b-4413-a366-adde0401df50",
  • "name": "Sample Tag Category",
  • "description": "Updated sample description",
  • "org": "{ORG_ID}",
  • "createdBy": "{USER_ID}",
  • "createdAt": "1661752268000",
  • "modifiedBy": "{USER_ID}",
  • "modifiedAt": "1661752268000",
  • "tagCount": 0
}

Delete a specific tag category

Important: Only the system administrator and the product administrator can use this API call.

Request
path Parameters
TAG_CATEGORY_ID
required
string

The ID of the tag category.

header Parameters
Authorization
required
string

The access token which can be copied from your Experience Platform integration, prefixed with "Bearer ". For more information on how to obtain this value, visit the authentication tutorial.

Content-Type
required
string

The type of content being sent in the body of the request. This value should be application/json.

x-gw-ims-org-id
required
string

The Organization ID which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

x-api-key
required
string

The API key which can be copied from your Experience Platform integration. For more information on how to obtain this value, visit the authentication tutorial.

Responses
200

Success

delete/unifiedtags/tagCategory/{TAG_CATEGORY_ID}