{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Asset Group API V3 — Developer Guide","description":"Sprinklr offers robust, convenient, and simple RESTful Web service APIs to integrate data from Sprinklr to any external system.","keywords":["Sprinklr API","Sprinklr Developer Portal","OAuth 2.0","RESTful API","Social Media API","Customer Experience API","Unified-CXM","Social Listening API"]},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"asset-group-api-v3--developer-guide","__idx":0},"children":["Asset Group API V3 — Developer Guide"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Applies to:"]}," Sprinklr Asset Group API V3 (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/asset-group"]},")"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/asset-group"},"children":["Asset Group | Sprinklr Developer Portal"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"1-overview","__idx":1},"children":["1. Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["asset group"]}," is a grouping of entities in Sprinklr. For example, an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["User Group"]},", which comprises multiple users at the Workspace level. The Asset Group APIs let you perform CRUD operations on these groups programmatically."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supported asset groups (V2 portal listing):"]}," Account Groups, User Groups, Topic Groups, Workspace Groups."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Asset Group V3 exposes full CRUD across two paths, differentiated by HTTP method:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Operation"},"children":["Operation"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":["Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":["Path"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"operationId"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["operationId"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create asset group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/asset-group"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupApiV3_createAssetGroup"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch asset group by id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/asset-group/{groupId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupApiV3_getAssetGroup"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update asset group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/asset-group/{groupId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupApiV3_updateAssetGroup"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete asset group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/asset-group/{groupId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupApiV3_deleteAssetGroup"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the central design change from V2, which used ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/asset-group"]}," for creation and the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v2/asset-group/{groupId}"]}," resource for read, update, and delete. In V3 the paths are identical in shape but sit under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3"]},", return the V3 response envelope, and are backed by formal request/response schemas."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"11-the-asset-group-data-model","__idx":2},"children":["1.1 The asset group data model"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Layer"},"children":["Layer"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Object / field group"},"children":["Object / field group"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What it holds"},"children":["What it holds"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identity"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Group identity and label"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Membership"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetIds[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The asset identifiers that belong to the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Classification"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["How the group is populated, and what kind of asset it contains"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom data"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomFields"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomFields"]}," (request), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomProperties"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomProperties"]}," (response)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client- and partner-level custom fields, each a map of key → list of string values"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Governance"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions[]"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Who can act on the assets, and who is subscribed to the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["System"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerUserId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spaceId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server-managed metadata"]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["⚠️ ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Naming asymmetry."]}," The request schema (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupRequest"]},") uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomFields"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomFields"]},". The response schema (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroup"]},") returns the same data as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomProperties"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomProperties"]},". Do not assume round-trip symmetry when mapping objects in your client code."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"12-addressing-an-asset-group","__idx":3},"children":["1.2 Addressing an asset group"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An asset group is addressed by its Sprinklr identifier only:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Path parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupId"]}]}," — type ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["String"]},", required, described as \"Group id\" in the specification. Example from the V3 create response: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6a8d7eebb1f9c0f214fd4011"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There is no fetch-by-name, bulk-fetch, or search operation for asset groups in the V3 specification."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-base-urls-and-environments","__idx":4},"children":["2. Base URLs and environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All V3 API calls are sent to:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["So the asset group resource is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/asset-group\nhttps://api3.sprinklr.com/{env}/api/v3/asset-group/{groupId}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," with your assigned environment identifier. The specification declares the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["env"]}," server variable with default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod"]}," and the following enumerated values:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod3"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod4"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod5"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod6"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod8"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod11"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod12"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod15"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod16"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod17"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod18"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod19"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod21"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod25"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://legacy-dev.sprinklr.com/apis"},"children":["APIs | Sprinklr Developer Portal"]}," for the published environment list [doc:turn1doc11]."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-authentication-and-common-headers","__idx":5},"children":["3. Authentication and common headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All Asset Group API calls are authenticated with OAuth 2.0."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Header"},"children":["Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":["Purpose"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required on"},"children":["Required on"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Bearer {{accessToken}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Credential used by the API to authenticate a user with the server. For generating the authorization token, refer to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorize"]}," section on the developer portal."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["API key that authenticates the application with the server. For generating an API key, refer to the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Getting Started"]}," guide."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Representation header that determines the type of data (media/resource) present in the request body"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Accept"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines the acceptable response type from the server"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["All requests"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permissions."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupApiV3"]}," was updated to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["require ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MANAGE"]}," permission for create and edit"]},". A caller without the required permission receives ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sprinklr's API governance model inherits the calling user's roles and permissions: all permissions tied to a user are equally applied to that user's API key, so a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," almost always indicates a governance gap rather than a malformed request [doc:turn1doc9]."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-write-operations","__idx":6},"children":["4. Write operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"41-create-an-asset-group","__idx":7},"children":["4.1 Create an asset group"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/asset-group"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates an asset group. The response returns the group ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," and the other related objects."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Endpoint as documented in the V3 source document:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/asset-group/\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body--assetgrouprequest","__idx":8},"children":["Request body — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupRequest"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Required properties per the specification: ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(per V3 doc)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["int64"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client id of the group — the client in which to make the changes"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(per V3 doc)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Asset ids in the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetIds[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of an asset to be added to the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (map of String → List[String])"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client-level custom fields of the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomFields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (map of String → List[String])"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner-level custom fields of the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GroupType"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of group, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEFINED"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DYNAMIC"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetType"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of asset in the group. Enum: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BRAND"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[Object] (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Asset permissions assigned to the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of entity receiving the permission, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GLOBAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ids based on the specified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[Object] (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Subscriber"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subscribers of the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of subscriber, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GLOBAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ids based on the specified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required-field conflict."]}," The OpenAPI schema marks only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}," as required; the V3 source document marks ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetIds"]}," as Required, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions[].ids"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[].ids"]}," as Required, while the schema marks the nested ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}," as optional. Treat the schema as authoritative for validation and see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#10-questions-for-the-api-owner"},"children":["§10"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request","__idx":9},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/asset-group/' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json' \\\n--header 'Content-Type: application/json' \\\n--data '{\n  \"name\": \"Santhosh Asset Group8\",\n  \"description\": \"Asset Group created via V3 API\",\n  \"clientId\": 66000002,\n  \"assetIds\": [\n    \"600054962\"\n  ],\n  \"groupType\": \"DEFINED\",\n  \"assetType\": \"ACCOUNT\",\n  \"assetPermissions\": [\n    {\n      \"type\": \"USER\",\n      \"ids\": [\n        \"600037831\"\n      ]\n    }\n  ],\n  \"subscribers\": [\n    {\n      \"type\": \"USER\",\n      \"ids\": [\n        \"600037831\"\n      ]\n    }\n  ]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response","__idx":10},"children":["Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": {\n    \"id\": \"6a8d7eebb1f9c0f214fd4011\",\n    \"name\": \"Santhosh Asset Group8\",\n    \"description\": \"Asset Group created via V3 API\",\n    \"assetIds\": [\n      \"600054962\"\n    ],\n    \"createdTime\": 1787657963670,\n    \"modifiedTime\": 1787657963670,\n    \"ownerUserId\": 66015421,\n    \"spaceId\": 66001165,\n    \"deleted\": false,\n    \"groupType\": \"DEFINED\",\n    \"assetType\": \"ACCOUNT\",\n    \"assetPermissions\": [\n      {\n        \"type\": \"USER\",\n        \"ids\": [\n          \"600037831\"\n        ]\n      }\n    ],\n    \"subscribers\": [\n      {\n        \"type\": \"USER\",\n        \"ids\": [\n          \"600037831\"\n        ]\n      }\n    ]\n  },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters","__idx":11},"children":["Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub-parameter"},"children":["Sub-parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroup"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Details of the created asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifiers of assets included in the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetIds[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of an asset included in the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (map of String → List[String])"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client-level custom fields of the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object (map of String → List[String])"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner-level custom fields of the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long (epoch ms)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the asset group was created"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long (epoch ms)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the asset group was last modified"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ownerUserId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the user who owns the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spaceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the space (client id) associated with the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deleted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the asset group has been deleted"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of assets contained in the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Permissions configured for the assets in the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions[].type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of entity to which permissions are assigned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions[].ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifiers of entities granted permissions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subscribers associated with the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[].type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of entity subscribed to the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[].ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifiers of entities subscribed to the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Errors encountered while processing the request. An empty array indicates no errors occurred."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Schema-required fields on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroup"]}," are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"42-update-an-asset-group","__idx":12},"children":["4.2 Update an asset group"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/asset-group/{groupId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates an existing asset group and returns the updated objects."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Endpoint as documented in the V3 source document:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/asset-group/id={{assetGroupId}}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters","__idx":13},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":["Required/Optional"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Id of the group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body--assetgrouprequest-1","__idx":14},"children":["Request body — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupRequest"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," takes the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupRequest"]}," schema as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},". The V3 source document lists the following required/optional split for the update body:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":["Required/Optional"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the asset group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(per V3 doc; Optional in schema)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the asset group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The client id in which to make the changes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(per V3 doc; Integer ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["int64"]}," in schema)"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Asset ids to be included in the group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of the group. Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEFINED"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Asset type of the group. Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Asset permissions assigned to the group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions[].type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of entity receiving the asset permission. Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GLOBAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions[].ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ids based on the specified type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Subscribers of the asset group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[].type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of subscriber. Example: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GLOBAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]},"."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[].ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ids based on the specified type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-1","__idx":15},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PUT 'https://api3.sprinklr.com/{env}/api/v3/asset-group/id={{assetGroupId}}' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n  \"name\": \"Santhosh Asset Group7 Updated\",\n  \"description\": \"Asset Group updated via V3 API\",\n  \"clientId\": 66000002,\n  \"assetIds\": [\"600054962\"],\n  \"groupType\": \"DEFINED\",\n  \"assetType\": \"ACCOUNT\",\n  \"assetPermissions\": [\n    {\n      \"type\": \"USER\",\n      \"ids\": [\"600037831\"]\n    }\n  ],\n  \"subscribers\": [\n    {\n      \"type\": \"USER\",\n      \"ids\": [\"600037831\"]\n    }\n  ]\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-1","__idx":16},"children":["Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"204 No Content\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"put-replaces--it-does-not-merge","__idx":17},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," replaces — it does not merge"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," sends the full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupRequest"]}," document. There is no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," operation for asset groups in V3, so ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["any field you omit from the body is at risk of being cleared"]},". Read the group with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," first, apply your changes to the returned object, and send the complete document back."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"43-delete-an-asset-group","__idx":18},"children":["4.3 Delete an asset group"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/asset-group/{groupId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Deletes an asset group by group id."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/asset-group/{groupId}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters-1","__idx":19},"children":["Path parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":["Required/Optional"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Id of the group"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-2","__idx":20},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request DELETE 'https://api3.sprinklr.com/{env}/api/v3/asset-group/{groupId}' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-2","__idx":21},"children":["Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"HTTP Status: 204 No Content\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-read-operations","__idx":22},"children":["5. Read operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-fetch-an-asset-group-by-id","__idx":23},"children":["5.1 Fetch an asset group by id"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/asset-group/{groupId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Fetches an asset group's details and all related objects, using the group id."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/asset-group/{groupId}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-parameters","__idx":24},"children":["Request parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":["Required/Optional"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the asset group whose details are being retrieved. ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["(The V3 source document names this parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetGroupId"]}," in its parameter table; the specification and URL template name it ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupId"]},".)"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-3","__idx":25},"children":["Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location 'https://api3.sprinklr.com/{env}/api/v3/asset-group/{groupId}' \\\n--header 'Authorization: Bearer {{accessToken}}' \\\n--header 'Key: {{apiKey}}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-3","__idx":26},"children":["Response"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": \"6a8d8262b1f9c0f214fd420f\",\n      \"name\": \"Santhosh Asset Group9\",\n      \"description\": \"Asset Group created via V3 API\",\n      \"assetIds\": [\n        \"600054962\"\n      ],\n      \"createdTime\": 1787658850242,\n      \"modifiedTime\": 1787658850242,\n      \"ownerUserId\": 66015421,\n      \"spaceId\": 66001165,\n      \"deleted\": false,\n      \"groupType\": \"DEFINED\",\n      \"assetType\": \"ACCOUNT\"\n    }\n  ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"response-parameters-1","__idx":27},"children":["Response parameters"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of asset groups returned by the API"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Name of the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Description of the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].assetIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifiers of assets included in the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].assetIds[]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique identifier of an asset included in the group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].createdTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long (epoch ms)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the asset group was created"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].modifiedTime"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long (epoch ms)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When the asset group was last modified"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].ownerUserId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the user who owns the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].spaceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Long"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the space associated with the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].deleted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Whether the asset group has been deleted"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].groupType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data[].assetType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type of assets contained in the asset group"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[Object]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Errors encountered while processing the request. An empty array indicates no errors occurred."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-response-format-and-status-codes","__idx":28},"children":["6. Response format and status codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"61-the-v3-envelope","__idx":29},"children":["6.1 The V3 envelope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Asset Group V3 responses use the standard V3 envelope:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": { },\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The error envelope (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]},") used by all ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["4xx"]}," responses is:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object, nullable"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Null on error"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array[Error]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One entry per error"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["24-character hex ObjectId (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].code"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error code (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Dotted error key, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account.not.found"]}," (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["required"]},")"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response metadata"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-response-codes","__idx":30},"children":["6.2 Response codes"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Code"},"children":["HTTP Code"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Declared by"},"children":["Declared by"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scenario"},"children":["Scenario"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OpenAPI spec (all four operations)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," return the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroup"]}," object; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}," declare a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," body"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V3 source documents (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},")"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation succeeded; no response body returned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OpenAPI spec"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bad request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Malformed request or invalid parameters. Body: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OpenAPI spec"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing or invalid authentication"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," token or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Key"]},". Body: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OpenAPI spec"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Caller lacks the required permission (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MANAGE"]}," for create and edit). Body: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["OpenAPI spec"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Resource not found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No asset group exists for the supplied ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupId"]},". Body: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ErrorResponse"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-v2--v3-migration","__idx":31},"children":["7. V2 → V3 migration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"71-endpoint-mapping","__idx":32},"children":["7.1 Endpoint mapping"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2"},"children":["V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3"},"children":["V3"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/asset-group"]}," (create) [doc:turn1doc8]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/asset-group"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/asset-group/{groupId}"]}," (read)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/asset-group/{groupId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v2/asset-group/{groupId}"]}," (update)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/asset-group/{groupId}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v2/asset-group/{groupId}"]}," (delete)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/asset-group/{groupId}"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The four V2 endpoints listed above are the exact set named as the parity scope for V3."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The path shapes are unchanged. The migration work is in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["base path"]},", the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["response envelope"]},", the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["field names"]},", and the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["enum surface"]}," — not in the routing."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"72-field-and-behaviour-mapping","__idx":33},"children":["7.2 Field and behaviour mapping"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Aspect"},"children":["Aspect"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API V2"},"children":["API V2"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"API V3"},"children":["API V3"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Impact"},"children":["Impact"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Base path"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v2/asset-group"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/asset-group"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update base URL only; resource paths are identical"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Response structure"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Flat asset group object at the response root [doc:turn1doc8]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{\"data\": ..., \"errors\": []}"]}," envelope"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Access the group via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response.data"]},", not the root"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Error handling"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["HTTP status only"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Structured ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[]"]}," array with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["code"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Parse ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[]"]}," for granular failure reasons"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Custom fields on read"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomFields"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomFields"]}," in the V2 response [doc:turn1doc8]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomProperties"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomProperties"]}," in the V3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroup"]}," response"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rename on the read path. Request-side names (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomFields"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomFields"]},") are unchanged."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client id on read"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 response example includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," [doc:turn1doc8]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroup"]}," exposes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spaceId"]}," (described as \"Client id of the group\"); ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," remains a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["request"]}," field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Map ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spaceId"]}," → your V2 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," consumer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}," enum"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BRAND"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BENCHMARKING_ACCOUNT"]}," [doc:turn1doc8]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BRAND"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BENCHMARKING_ACCOUNT"]}," is not in the V3 enum."]}," Audit existing groups before cutover — see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#10-questions-for-the-api-owner"},"children":["§10"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Documented as \"Type of the group (Static/Dynamic)\" [doc:turn1doc8]; V2 example uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DYNAMIC"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Free-form string; spec description \"Type of group e.g. DEFINED, DYNAMIC\"; V3 examples use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEFINED"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not a closed enum in V3. Verify accepted values with the API owner."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required [doc:turn1doc8]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupRequest"]}," schema"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Existing payloads remain valid"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required request fields"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetId"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}," [doc:turn1doc8]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}," (schema)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fewer schema-mandated fields; see the conflict note in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"#41-create-an-asset-group"},"children":["§4.1"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Governed by the calling user's roles [doc:turn1doc9]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create and edit explicitly require ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MANAGE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A key that worked on V2 writes may return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," on V3"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success status on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not specified in the V2 reference"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}," observed; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," declared in the spec"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accept both"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"73-migration-steps","__idx":34},"children":["7.3 Migration steps"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update the base URL."]}," Point at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api3.sprinklr.com/{env}/api/v3/asset-group"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Unwrap the envelope."]}," Read the group from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response.data"]}," instead of the response root, and tolerate ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," being an object (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]},") or a single-element array (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Handle the new error format."]}," Inspect ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["response.errors[]"]}," and log ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].code"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors[].message"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rename read-side custom fields."]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomFields"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientCustomProperties"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomFields"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["partnerCustomProperties"]},". Leave the request-side names as-is."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Remap ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," on read"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spaceId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Audit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}," values."]}," Any integration that sends or expects ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BENCHMARKING_ACCOUNT"]}," must be resolved before cutover."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Confirm ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType"]}," values."]}," V2 documentation says Static/Dynamic; V2 examples use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DYNAMIC"]},"; V3 examples use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEFINED"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Grant ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MANAGE"]}," permission"]}," to the API user used for create and update calls."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accept both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]}]}," as success on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]},", and do not assume a JSON body."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Read-modify-write on updates."]}," V3 has no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},"; send the complete document on every ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},"."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"8-reference--enums-and-reusable-objects","__idx":35},"children":["8. Reference — enums and reusable objects"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"81-assettype","__idx":36},"children":["8.1 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetType"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":["Value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User assets"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BRAND"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Brand assets"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account assets — used in all V3 examples"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client assets"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BENCHMARKING_ACCOUNT"]},", present in the V2 documentation [doc:turn1doc8], is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," part of the V3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetType"]}," enum."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"82-grouptype","__idx":37},"children":["8.2 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GroupType"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Typed as a plain ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]}," in the specification, described as \"Type of Group\" (request-side description: \"Type of group e.g. DEFINED, DYNAMIC\"). It is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," a closed enum in V3. Values seen in documented examples: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DEFINED"]}," (V3), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DYNAMIC"]}," (V2)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"83-assetshareconfig-used-by-assetpermissions-","__idx":38},"children":["8.3 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetShareConfig"]}," (used by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions[]"]},")"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GLOBAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ids based on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"84-subscriber-used-by-subscribers-","__idx":39},"children":["8.4 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Subscriber"]}," (used by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[]"]},")"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required"},"children":["Required"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Type, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GLOBAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ids"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List[String]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Ids based on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Both objects are structurally identical but are separate components in the specification. There is also an unrelated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetPermission"]}," component (holding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfigs[]"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["grants[]"]},") that is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," referenced by any asset group operation — do not confuse it with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions"]}," array on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroup"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AssetGroupRequest"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"9-use-cases-and-best-practices","__idx":40},"children":["9. Use cases and best practices"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"91-create-an-account-group-for-a-campaign","__idx":41},"children":["9.1 Create an account group for a campaign"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v3/asset-group"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType: \"ACCOUNT\""]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupType: \"DEFINED\""]},", and the account ids in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetIds[]"]},". Grant access at creation time via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions[]"]}," and notify owners via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[]"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"92-add-an-asset-to-an-existing-group","__idx":42},"children":["9.2 Add an asset to an existing group"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["There is no incremental-add operation. Call ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/asset-group/{groupId}"]},", append the new id to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetIds[]"]}," from the returned object, and send the complete document back with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"93-reconcile-groups-from-an-external-system-of-record","__idx":43},"children":["9.3 Reconcile groups from an external system of record"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Where your external system is authoritative, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}," is the correct verb — it replaces the whole document, so removals in the source system propagate. Where it is not authoritative, always read first."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"94-decommission-a-group","__idx":44},"children":["9.4 Decommission a group"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/asset-group/{groupId}"]},". Expect ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}," (or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200"]}," per the spec) and no body — do not attempt to parse the response as JSON."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"best-practices","__idx":45},"children":["Best practices"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Identifiers"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupId"]}," is a String (24-character hex ObjectId in all documented examples, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["6a8d8262b1f9c0f214fd420f"]},"). Do not coerce it to a number."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetIds[]"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions[].ids[]"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[].ids[]"]}," are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["arrays of strings"]},", even when the underlying ids are numeric (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["\"600054962\""]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," on the request is an ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["integer"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["int64"]},", for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["66000002"]},"), while the corresponding response field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["spaceId"]}," is also a Long. The V3 update document describes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," as String — the schema types it as an integer."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Updates"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["V3 has no ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]}," for asset groups. Every update is a full replace."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Do not rely on the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["?id="]}," query parameter shown in the update document; the specification defines only the path parameter."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Enums and casing"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetType"]}," values are uppercase and case-sensitive: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BRAND"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ACCOUNT"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}," values inside ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["assetPermissions[]"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["subscribers[]"]}," are documented as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["USER"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GLOBAL"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CLIENT"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Timestamps"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["createdTime"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modifiedTime"]}," are epoch milliseconds as 64-bit integers (for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["1787657963670"]},"). Do not parse them as seconds."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Permissions"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Provision ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MANAGE"]}," for the API user before migrating write traffic; a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403"]}," on V3 where V2 succeeded is the expected symptom of a missing grant."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error handling"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Always inspect the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," array even on a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2xx"]}," response — the envelope carries ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}," on success responses too (empty in the documented examples)."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credentials"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All tokens and keys in this guide are placeholders (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{accessToken}}"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{{apiKey}}"]},"). Never commit or log real keys."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]}]},"headings":[{"value":"Asset Group API V3 — Developer Guide","id":"asset-group-api-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"1.1 The asset group data model","id":"11-the-asset-group-data-model","depth":3},{"value":"1.2 Addressing an asset group","id":"12-addressing-an-asset-group","depth":3},{"value":"2. Base URLs and environments","id":"2-base-urls-and-environments","depth":2},{"value":"3. Authentication and common headers","id":"3-authentication-and-common-headers","depth":2},{"value":"4. Write operations","id":"4-write-operations","depth":2},{"value":"4.1 Create an asset group","id":"41-create-an-asset-group","depth":3},{"value":"Request body — AssetGroupRequest","id":"request-body--assetgrouprequest","depth":4},{"value":"Request","id":"request","depth":4},{"value":"Response","id":"response","depth":4},{"value":"Response parameters","id":"response-parameters","depth":4},{"value":"4.2 Update an asset group","id":"42-update-an-asset-group","depth":3},{"value":"Path parameters","id":"path-parameters","depth":4},{"value":"Request body — AssetGroupRequest","id":"request-body--assetgrouprequest-1","depth":4},{"value":"Request","id":"request-1","depth":4},{"value":"Response","id":"response-1","depth":4},{"value":"PUT replaces — it does not merge","id":"put-replaces--it-does-not-merge","depth":4},{"value":"4.3 Delete an asset group","id":"43-delete-an-asset-group","depth":3},{"value":"Path parameters","id":"path-parameters-1","depth":4},{"value":"Request","id":"request-2","depth":4},{"value":"Response","id":"response-2","depth":4},{"value":"5. Read operations","id":"5-read-operations","depth":2},{"value":"5.1 Fetch an asset group by id","id":"51-fetch-an-asset-group-by-id","depth":3},{"value":"Request parameters","id":"request-parameters","depth":4},{"value":"Request","id":"request-3","depth":4},{"value":"Response","id":"response-3","depth":4},{"value":"Response parameters","id":"response-parameters-1","depth":4},{"value":"6. Response format and status codes","id":"6-response-format-and-status-codes","depth":2},{"value":"6.1 The V3 envelope","id":"61-the-v3-envelope","depth":3},{"value":"6.2 Response codes","id":"62-response-codes","depth":3},{"value":"7. V2 → V3 migration","id":"7-v2--v3-migration","depth":2},{"value":"7.1 Endpoint mapping","id":"71-endpoint-mapping","depth":3},{"value":"7.2 Field and behaviour mapping","id":"72-field-and-behaviour-mapping","depth":3},{"value":"7.3 Migration steps","id":"73-migration-steps","depth":3},{"value":"8. Reference — enums and reusable objects","id":"8-reference--enums-and-reusable-objects","depth":2},{"value":"8.1 AssetType","id":"81-assettype","depth":3},{"value":"8.2 GroupType","id":"82-grouptype","depth":3},{"value":"8.3 AssetShareConfig (used by assetPermissions[] )","id":"83-assetshareconfig-used-by-assetpermissions-","depth":3},{"value":"8.4 Subscriber (used by subscribers[] )","id":"84-subscriber-used-by-subscribers-","depth":3},{"value":"9. Use cases and best practices","id":"9-use-cases-and-best-practices","depth":2},{"value":"9.1 Create an account group for a campaign","id":"91-create-an-account-group-for-a-campaign","depth":3},{"value":"9.2 Add an asset to an existing group","id":"92-add-an-asset-to-an-existing-group","depth":3},{"value":"9.3 Reconcile groups from an external system of record","id":"93-reconcile-groups-from-an-external-system-of-record","depth":3},{"value":"9.4 Decommission a group","id":"94-decommission-a-group","depth":3},{"value":"Best practices","id":"best-practices","depth":3}],"frontmatter":{"seo":{"title":"Asset Group API V3 — Developer Guide"}},"lastModified":"2026-10-22T18:27:14.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/asset-group-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}