Applies to: Sprinklr Asset Group API V3
V2 API reference: Asset Group | Sprinklr Developer Portal
An asset group is a grouping of entities in Sprinklr. For example, an Account Group is a grouping of multiple accounts created either by individually selecting accounts to add (static) or based on one or more properties (dynamic). Another example is a User Group, which comprises multiple users at the Workspace level. The Asset Group APIs let you perform CRUD operations on these groups programmatically.
📖 Related Knowledge Base Articles: Account Group and User Group
You need an OAuth 2.0 access token and API key to call these APIs. Use the environment-specific API host shown in each endpoint.
POSTCreate an Asset GroupGETRead an Asset GroupPUTUpdate an Asset GroupDELETEDelete an Asset Group
All API calls are sent to the production endpoint:
https://api3.sprinklr.com/{env}/api/v3So the resource in production is:
https://api3.sprinklr.com/{env}/api/v3/asset-groupReplace {env} with your assigned environment identifier (prod0, prod2, prod11, and so on — see APIs | Sprinklr Developer Portal for the environment list).
All Asset Group API calls are authenticated with OAuth 2.0. The specification declares two security schemes, both applied globally:
| Scheme | Type | Detail |
|---|---|---|
bearerAuth | http, scheme bearer | Bearer format JWT, sent in the Authorization header |
apiKeyAuth | apiKey | Sent in the Key header |
| Header | Value | Description |
|---|---|---|
Authorization | Bearer {token} | Authenticates the user with the server. |
Key | {api-key} | Authenticates the application with the server. |
Content-Type | application/json | Identifies the request-body media type. |
Accept | application/json | Identifies the expected response type. |
Creates an asset group. The response returns the group id and the other related objects.
Endpoint: https://api3.sprinklr.com/{env}/api/v3/asset-group/
Required properties per the specification: name, groupType, assetType.
| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
name | Required | String | Name of the asset group | |
description | Optional | String | Description of the asset group | |
clientId | Required (per V3 doc) | Integer (int64) | Client id of the group — the client in which to make the changes | |
assetIds | Required (per V3 doc) | List[String] | Asset ids in the group | |
assetIds[] | Required | String | Unique identifier of an asset to be added to the group | |
clientCustomFields | Optional | Object (map of String → List[String]) | Client-level custom fields of the group | |
partnerCustomFields | Optional | Object (map of String → List[String]) | Partner-level custom fields of the group | |
groupType | Required | String (GroupType) | Type of group, for example DEFINED, DYNAMIC | |
assetType | Required | String (AssetType) | Type of asset in the group. Enum: USER, BRAND, ACCOUNT, CLIENT | |
assetPermissions | Optional | List[Object] (AssetShareConfig) | Asset permissions assigned to the group | |
type | Required | String | Type of entity receiving the permission, for example USER, GLOBAL, CLIENT | |
ids | Optional | List[String] | Ids based on the specified type | |
subscribers | Optional | List[Object] (Subscriber) | Subscribers of the group | |
type | Required | String | Type of subscriber, for example USER, GLOBAL, CLIENT | |
ids | Optional | List[String] | Ids based on the specified type |
curl --location 'https://api3.sprinklr.com/{env}/api/v3/asset-group/' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Santhosh Asset Group8",
"description": "Asset Group created via V3 API",
"clientId": 66000002,
"assetIds": [
"600054962"
],
"groupType": "DEFINED",
"assetType": "ACCOUNT",
"assetPermissions": [
{
"type": "USER",
"ids": [
"600037831"
]
}
],
"subscribers": [
{
"type": "USER",
"ids": [
"600037831"
]
}
]
}'{
"data": {
"id": "6a8d7eebb1f9c0f214fd4011",
"name": "Santhosh Asset Group8",
"description": "Asset Group created via V3 API",
"assetIds": [
"600054962"
],
"createdTime": 1787657963670,
"modifiedTime": 1787657963670,
"ownerUserId": 66015421,
"spaceId": 66001165,
"deleted": false,
"groupType": "DEFINED",
"assetType": "ACCOUNT",
"assetPermissions": [
{
"type": "USER",
"ids": [
"600037831"
]
}
],
"subscribers": [
{
"type": "USER",
"ids": [
"600037831"
]
}
]
},
"errors": []
}| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
data | Required | Object (AssetGroup) | Details of the created asset group | |
id | Required | String | Unique identifier of the asset group | |
name | Required | String | Name of the asset group | |
description | Optional | String | Description of the asset group | |
assetIds | Required | List[String] | Identifiers of assets included in the asset group | |
assetIds[] | Required | String | Unique identifier of an asset included in the group | |
clientCustomProperties | Optional | Object (map of String → List[String]) | Client-level custom fields of the group | |
partnerCustomProperties | Optional | Object (map of String → List[String]) | Partner-level custom fields of the group | |
createdTime | Required | Long (epoch ms) | When the asset group was created | |
modifiedTime | Required | Long (epoch ms) | When the asset group was last modified | |
ownerUserId | Required | Long | Identifier of the user who owns the asset group | |
spaceId | Required | Long | Identifier of the space (client id) associated with the group | |
deleted | Required | Boolean | Whether the asset group has been deleted | |
groupType | Required | String | Type of asset group | |
assetType | Required | String | Type of assets contained in the group | |
assetPermissions | Optional | List[Object] | Permissions configured for the assets in the group | |
assetPermissions[].type | Required | String | Type of entity to which permissions are assigned | |
assetPermissions[].ids | Required | List[String] | Identifiers of entities granted permissions | |
subscribers | Optional | List[Object] | Subscribers associated with the asset group | |
subscribers[].type | Required | String | Type of entity subscribed to the group | |
subscribers[].ids | Required | List[String] | Identifiers of entities subscribed to the group | |
errors | Required | List[Object] | Errors encountered while processing the request. An empty array indicates no errors occurred. |
Schema-required fields on AssetGroup are id, name, assetType.
Updates an existing asset group and returns the updated objects.
Endpoint: https://api3.sprinklr.com/{env}/api/v3/asset-group/{assetGroupId}
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
groupId | Required | Id of the group | String |
PUT takes the same AssetGroupRequest schema as POST. The V3 source document lists the following required/optional split for the update body:
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
name | Required | Name of the asset group | String |
description | Required (per V3 doc; Optional in schema) | Description of the asset group | String |
clientId | Required | The client id in which to make the changes | String (per V3 doc; Integer int64 in schema) |
assetIds | Required | Asset ids to be included in the group | Array of String |
groupType | Required | Type of the group. Example: DEFINED. | String |
assetType | Required | Asset type of the group. Example: ACCOUNT. | String |
assetPermissions | Optional | Asset permissions assigned to the group | Array of Object |
assetPermissions[].type | Required | Type of entity receiving the asset permission. Example: USER, GLOBAL, CLIENT. | String |
assetPermissions[].ids | Optional | Ids based on the specified type | Array of String |
subscribers | Optional | Subscribers of the asset group | Array of Object |
subscribers[].type | Required | Type of subscriber. Example: USER, GLOBAL, CLIENT. | String |
subscribers[].ids | Optional | Ids based on the specified type | Array of String |
curl --location --request PUT 'https://api3.sprinklr.com/{env}/api/v3/asset-group/{assetGroupId}' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}' \
--header 'Content-Type: application/json' \
--data '{
"name": "Santhosh Asset Group7 Updated",
"description": "Asset Group updated via V3 API",
"clientId": 66000002,
"assetIds": ["600054962"],
"groupType": "DEFINED",
"assetType": "ACCOUNT",
"assetPermissions": [
{
"type": "USER",
"ids": ["600037831"]
}
],
"subscribers": [
{
"type": "USER",
"ids": ["600037831"]
}
]
}'HTTP Status: 204 No ContentYou can delete an Asset group via this API using group Id.
Endpoint: https://api3.sprinklr.com/{env}/api/v3/asset-group/{assetGroupId}
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
groupId | Required | Id of the group | String |
curl --location --request DELETE 'https://api3.sprinklr.com/{env}/api/v3/asset-group/{assetGroupId}' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}' \
--header 'Accept: application/json'HTTP Status: 204 No ContentFetches an asset group's details and all related objects, using the group id.
Endpoint: https://api3.sprinklr.com/{env}/api/v3/asset-group/{groupId}
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
groupId | Required | Unique identifier of the asset group whose details are being retrieved. (The V3 source document names this parameter assetGroupId in its parameter table; the specification and URL template name it groupId.) | String |
curl --location 'https://api3.sprinklr.com/{env}/api/v3/asset-group/{groupId}' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}'{
"data": [
{
"id": "6a8d8262b1f9c0f214fd420f",
"name": "Santhosh Asset Group9",
"description": "Asset Group created via V3 API",
"assetIds": [
"600054962"
],
"createdTime": 1787658850242,
"modifiedTime": 1787658850242,
"ownerUserId": 66015421,
"spaceId": 66001165,
"deleted": false,
"groupType": "DEFINED",
"assetType": "ACCOUNT"
}
],
"errors": []
}| Parameter | Required | Type | Description |
|---|---|---|---|
data | Required | List[Object] | List of asset groups returned by the API |
data[].id | Required | String | Unique identifier of the asset group |
data[].name | Required | String | Name of the asset group |
data[].description | Optional | String | Description of the asset group |
data[].assetIds | Required | List[String] | Identifiers of assets included in the asset group |
data[].assetIds[] | Required | String | Unique identifier of an asset included in the group |
data[].createdTime | Required | Long (epoch ms) | When the asset group was created |
data[].modifiedTime | Required | Long (epoch ms) | When the asset group was last modified |
data[].ownerUserId | Required | Long | Identifier of the user who owns the asset group |
data[].spaceId | Required | Long | Identifier of the space associated with the asset group |
data[].deleted | Required | Boolean | Whether the asset group has been deleted |
data[].groupType | Required | String | Type of asset group |
data[].assetType | Required | String | Type of assets contained in the asset group |
errors | Required | List[Object] | Errors encountered while processing the request. An empty array indicates no errors occurred. |
The Asset Group API V3 enables developers to programmatically manage groups of entities in Sprinklr. Asset groups can represent entities such as accounts, users, brands, or clients and can be defined statically or dynamically.
Create an asset group and specify its name, assets, group type, and asset type. The API supports asset types such as USER, BRAND, ACCOUNT, and CLIENT, and group types such as DEFINED and DYNAMIC.
Use assetIds to associate multiple asset identifiers with an asset group. For example, an Account Group can contain multiple accounts, while a User Group can contain multiple users at the Workspace level.
Retrieve an asset group by its group ID to obtain information such as its name, description, asset IDs, group type, asset type, owner, associated space, and creation or modification information returned by the API.
Modify an asset group's configuration using its group ID. The documented update request supports properties including the name, description, client ID, asset IDs, group type, asset type, permissions, and subscribers.
Specify assetPermissions to associate permissions with entities such as a USER, GLOBAL, or CLIENT, together with the applicable entity IDs.
Specify subscribers for an asset group, including subscriber types such as USER, GLOBAL, or CLIENT and their corresponding IDs.