Skip to content

Asset Group API V3 — Developer Guide


1. Overview

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

Before you Begin

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.


2. API Endpoints

  • POSTCreate an Asset Group
  • GETRead an Asset Group
  • PUT Update an Asset Group
  • DELETE Delete an Asset Group

3. Base URLs and Environments

All API calls are sent to the production endpoint:

https://api3.sprinklr.com/{env}/api/v3

So the resource in production is:

https://api3.sprinklr.com/{env}/api/v3/asset-group

Replace {env} with your assigned environment identifier (prod0, prod2, prod11, and so on — see APIs | Sprinklr Developer Portal for the environment list).


4. Authentication and Common Headers

All Asset Group API calls are authenticated with OAuth 2.0. The specification declares two security schemes, both applied globally:

SchemeTypeDetail
bearerAuthhttp, scheme bearerBearer format JWT, sent in the Authorization header
apiKeyAuthapiKeySent in the Key header
HeaderValueDescription
AuthorizationBearer {token}Authenticates the user with the server.
Key{api-key}Authenticates the application with the server.
Content-Typeapplication/jsonIdentifies the request-body media type.
Acceptapplication/jsonIdentifies the expected response type.

5. Write Operations

5.1 Create an Asset Group

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/

Request Parameters

Required properties per the specification: name, groupType, assetType.

ParameterSub-parameterRequiredTypeDescription
nameRequiredStringName of the asset group
descriptionOptionalStringDescription of the asset group
clientIdRequired (per V3 doc)Integer (int64)Client id of the group — the client in which to make the changes
assetIdsRequired (per V3 doc)List[String]Asset ids in the group
assetIds[]RequiredStringUnique identifier of an asset to be added to the group
clientCustomFieldsOptionalObject (map of String → List[String])Client-level custom fields of the group
partnerCustomFieldsOptionalObject (map of String → List[String])Partner-level custom fields of the group
groupTypeRequiredString (GroupType)Type of group, for example DEFINED, DYNAMIC
assetTypeRequiredString (AssetType)Type of asset in the group. Enum: USER, BRAND, ACCOUNT, CLIENT
assetPermissionsOptionalList[Object] (AssetShareConfig)Asset permissions assigned to the group
typeRequiredStringType of entity receiving the permission, for example USER, GLOBAL, CLIENT
idsOptionalList[String]Ids based on the specified type
subscribersOptionalList[Object] (Subscriber)Subscribers of the group
typeRequiredStringType of subscriber, for example USER, GLOBAL, CLIENT
idsOptionalList[String]Ids based on the specified type

Example Request

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"
      ]
    }
  ]
}'

Example Response

{
  "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": []
}

Response Parameters

ParameterSub-parameterRequiredTypeDescription
dataRequiredObject (AssetGroup)Details of the created asset group
idRequiredStringUnique identifier of the asset group
nameRequiredStringName of the asset group
descriptionOptionalStringDescription of the asset group
assetIdsRequiredList[String]Identifiers of assets included in the asset group
assetIds[]RequiredStringUnique identifier of an asset included in the group
clientCustomPropertiesOptionalObject (map of String → List[String])Client-level custom fields of the group
partnerCustomPropertiesOptionalObject (map of String → List[String])Partner-level custom fields of the group
createdTimeRequiredLong (epoch ms)When the asset group was created
modifiedTimeRequiredLong (epoch ms)When the asset group was last modified
ownerUserIdRequiredLongIdentifier of the user who owns the asset group
spaceIdRequiredLongIdentifier of the space (client id) associated with the group
deletedRequiredBooleanWhether the asset group has been deleted
groupTypeRequiredStringType of asset group
assetTypeRequiredStringType of assets contained in the group
assetPermissionsOptionalList[Object]Permissions configured for the assets in the group
assetPermissions[].typeRequiredStringType of entity to which permissions are assigned
assetPermissions[].idsRequiredList[String]Identifiers of entities granted permissions
subscribersOptionalList[Object]Subscribers associated with the asset group
subscribers[].typeRequiredStringType of entity subscribed to the group
subscribers[].idsRequiredList[String]Identifiers of entities subscribed to the group
errorsRequiredList[Object]Errors encountered while processing the request. An empty array indicates no errors occurred.

Schema-required fields on AssetGroup are id, name, assetType.


5.2 Update an Asset Group

Updates an existing asset group and returns the updated objects.

Endpoint: https://api3.sprinklr.com/{env}/api/v3/asset-group/{assetGroupId}

Path Parameters

ParameterRequired/OptionalDescriptionType
groupIdRequiredId of the groupString

Request body — AssetGroupRequest

PUT takes the same AssetGroupRequest schema as POST. The V3 source document lists the following required/optional split for the update body:

ParameterRequired/OptionalDescriptionType
nameRequiredName of the asset groupString
descriptionRequired (per V3 doc; Optional in schema)Description of the asset groupString
clientIdRequiredThe client id in which to make the changesString (per V3 doc; Integer int64 in schema)
assetIdsRequiredAsset ids to be included in the groupArray of String
groupTypeRequiredType of the group. Example: DEFINED.String
assetTypeRequiredAsset type of the group. Example: ACCOUNT.String
assetPermissionsOptionalAsset permissions assigned to the groupArray of Object
assetPermissions[].typeRequiredType of entity receiving the asset permission. Example: USER, GLOBAL, CLIENT.String
assetPermissions[].idsOptionalIds based on the specified typeArray of String
subscribersOptionalSubscribers of the asset groupArray of Object
subscribers[].typeRequiredType of subscriber. Example: USER, GLOBAL, CLIENT.String
subscribers[].idsOptionalIds based on the specified typeArray of String

Example Request

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"]
    }
  ]
}'

Example Response

HTTP Status: 204 No Content

5.3 Delete an Asset Group

You can delete an Asset group via this API using group Id.

Endpoint: https://api3.sprinklr.com/{env}/api/v3/asset-group/{assetGroupId}

Path Parameters

ParameterRequired/OptionalDescriptionType
groupIdRequiredId of the groupString

Example Request

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'

Example Response

HTTP Status: 204 No Content

6. Read operations

6.1 Read an Asset Group

Fetches an asset group's details and all related objects, using the group id.

Endpoint: https://api3.sprinklr.com/{env}/api/v3/asset-group/{groupId}

Request Parameters

ParameterRequired/OptionalDescriptionType
groupIdRequiredUnique 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

Example Request

curl --location 'https://api3.sprinklr.com/{env}/api/v3/asset-group/{groupId}' \
--header 'Authorization: Bearer {{accessToken}}' \
--header 'Key: {{apiKey}}'

Example Response

{
  "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": []
}

Response Parameters

ParameterRequiredTypeDescription
dataRequiredList[Object]List of asset groups returned by the API
data[].idRequiredStringUnique identifier of the asset group
data[].nameRequiredStringName of the asset group
data[].descriptionOptionalStringDescription of the asset group
data[].assetIdsRequiredList[String]Identifiers of assets included in the asset group
data[].assetIds[]RequiredStringUnique identifier of an asset included in the group
data[].createdTimeRequiredLong (epoch ms)When the asset group was created
data[].modifiedTimeRequiredLong (epoch ms)When the asset group was last modified
data[].ownerUserIdRequiredLongIdentifier of the user who owns the asset group
data[].spaceIdRequiredLongIdentifier of the space associated with the asset group
data[].deletedRequiredBooleanWhether the asset group has been deleted
data[].groupTypeRequiredStringType of asset group
data[].assetTypeRequiredStringType of assets contained in the asset group
errorsRequiredList[Object]Errors encountered while processing the request. An empty array indicates no errors occurred.

7. Use Cases

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.

1. Create asset groups programmatically

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.

2. Group multiple assets together

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.

3. Retrieve an existing asset group's configuration

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.

4. Update an existing asset group

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.

5. Configure asset-group permissions

Specify assetPermissions to associate permissions with entities such as a USER, GLOBAL, or CLIENT, together with the applicable entity IDs.

6. Configure asset-group subscribers

Specify subscribers for an asset group, including subscriber types such as USER, GLOBAL, or CLIENT and their corresponding IDs.