{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-guides/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Account 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":"account-api-v3--developer-guide","__idx":0},"children":["Account 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 Account API V3"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 API reference:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://dev.sprinklr.com/account"},"children":["Account API | 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":["account"]}," refers to the brand’s social media account that has been successfully added to Sprinklr. Once added, you can ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["view, edit, update, delete, or deactivate"]}," the account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["📖 Related Knowledge Base Article: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www.sprinklr.com/help/categories/account/64588f3a72241235fc62be8a"},"children":["Account"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2-api-endpoints","__idx":2},"children":["2. API Endpoints"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Operation"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Method"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Path"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Path"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch Account (by Id)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/account?id={id}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fully Update Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PUT"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/account?id={id}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partially Update Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["PATCH"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/account?id={id}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["DELETE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v3/account?id={id}&clientId={clientId}"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"3-base-url","__idx":3},"children":["3. Base URL"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All 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 Account resource in production is:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://api3.sprinklr.com/{env}/api/v3/account\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replace ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{env}"]}," with your assigned environment identifier (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod0"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod2"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prod11"]},", etc.)."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"4-authentication--headers","__idx":4},"children":["4. Authentication & Headers"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Header"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Value"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Value"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Purpose"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Purpose"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authorization"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Bearer {token}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the user with the server"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["api-key"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["{api-key}"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authenticates the application with the server"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Content-Type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["application/json"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares request body media type"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Accept"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["application/json"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Declares acceptable response type"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"5-account-operations","__idx":5},"children":["5. Account Operations"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"51-fetch-account","__idx":6},"children":["5.1 Fetch Account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/account?id={id}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves account details using its unique ID."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"query-parameter","__idx":7},"children":["Query Parameter"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unique ID of the account added in Sprinklr."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"steps-to-extract-account-id-from-sprinklr-ui","__idx":8},"children":["Steps to Extract Account ID from Sprinklr UI"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All Settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accounts"]}," page."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Locate the account you want."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["three‑dot icon"]}," next to the account name."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Details"]}," from the dropdown. A third‑pane window opens."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the window, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["copy URL icon"]}," at the top right."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Paste the copied URL into any encoder/decoder tool."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The account ID will appear in the decoded URL."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If the decoded URL contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/ACCOUNT/100426226/OVERVIEW"]},", then the account ID is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["100426226"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example--request","__idx":9},"children":["Example — Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request GET 'https://api3.sprinklr.com/{env}/api/v3/account?id=66000053' \\\n--header 'Authorization: {Enter your Access Token}' \\\n--header 'Key: {Enter your API KEY}' \\\n--header 'accept: application/json' \\\n--header 'Content-Type: application/json' \\\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"52-fully-update-account","__idx":10},"children":["5.2 Fully Update Account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/account?id={id}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replaces all custom properties on an account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"query-parameter-1","__idx":11},"children":["Query Parameter"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unique ID of the account added in Sprinklr."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"steps-to-extract-account-id-from-sprinklr-ui-1","__idx":12},"children":["Steps to Extract Account ID from Sprinklr UI"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All Settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accounts"]}," page."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Locate the account you want."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["three‑dot icon"]}," next to the account name."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Details"]}," from the dropdown. A third‑pane window opens."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the window, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["copy URL icon"]}," at the top right."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Paste the copied URL into any encoder/decoder tool."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The account ID will appear in the decoded URL."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If the decoded URL contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/ACCOUNT/100426226/OVERVIEW"]},", then the account ID is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["100426226"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request-parameters","__idx":13},"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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["spaceId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client (space) ID for client‑level custom properties."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["long"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["clientCustomProperties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client‑level custom properties to replace on the account. Keys are field names; values are string lists."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object (string → array of string)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["partnerCustomProperties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner‑level custom properties to replace on the account."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object (string → array of string)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example--request-1","__idx":14},"children":["Example — Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PUT 'https://api3.sprinklr.com/{env}/api/v3/account?id=66000053' \\\n--header 'Authorization: {Enter Your Access Token}' \\\n--header 'Key: {Enter Your API Key}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n    \"spaceId\": 66000002,\n    \"clientCustomProperties\": {\n        \"region\": [\"US\"]\n    },\n    \"partnerCustomProperties\": {\n        \"tier\": [\"gold\"]\n    }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"53-partially-update-account","__idx":15},"children":["5.3 Partially Update Account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/account?id={id}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates account details without overwriting the entire object.  Supports appending/merging custom properties, updating visibility/permissions, or deactivating an account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"query-parameter-2","__idx":16},"children":["Query Parameter"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unique ID of the account added in Sprinklr."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"steps-to-extract-account-id-from-sprinklr-ui-2","__idx":17},"children":["Steps to Extract Account ID from Sprinklr UI"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All Settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accounts"]}," page."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Locate the account you want."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["three‑dot icon"]}," next to the account name."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Details"]}," from the dropdown. A third‑pane window opens."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the window, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["copy URL icon"]}," at the top right."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Paste the copied URL into any encoder/decoder tool."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The account ID will appear in the decoded URL."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If the decoded URL contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/ACCOUNT/100426226/OVERVIEW"]},", then the account ID is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["100426226"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request-parameters-1","__idx":18},"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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["customProperties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partial custom properties update. See Object: customProperties."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["visibilityPermissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Visibility and/or share permission update. See Object: visibilityPermissions."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["active"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Set to false to deactivate the account. Only false is supported; true returns 400."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["deactivationReason"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reason recorded on deactivation. Defaults to ",{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Deactivated by user using API v3"]}," when omitted and active is false."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"object-customproperties","__idx":19},"children":["Object: customProperties"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["spaceId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Conditional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client (space) ID. Required when clientCustomProperties is non‑empty."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["long"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["clientCustomProperties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client‑level custom properties to append/merge (partial update)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object (string → array of string)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["partnerCustomProperties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Partner‑level custom properties to append/merge (partial update)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object (string → array of string)"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"object-visibilitypermissions","__idx":20},"children":["Object: visibilityPermissions"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["visibility"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Visibility to apply. See Object: visibility."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Share permissions to assign. See Object: permissions[] item."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of objects"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"object-visibility","__idx":21},"children":["Object: visibility"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["globallyVisible"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["When true, asset is globally visible."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["visibilityConfig"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Share targets for visibility. See Object: visibilityConfig[] item."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of objects"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"object-visibilityconfig-item","__idx":22},"children":["Object: visibilityConfig[] item"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Share target type (e.g. USER, GLOBAL, CLIENT)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Target IDs for the given type."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of string"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"object-permissions-item","__idx":23},"children":["Object: permissions[] item"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Share target type (e.g. USER, GLOBAL, CLIENT)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Optional"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Target IDs for the given type."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of string"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example--request-2","__idx":24},"children":["Example — Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request PATCH 'https://api3.sprinklr.com/{env}/api/v3/account?id=66000053' \\\n--header 'Authorization: {Enter Your Access Token}' \\\n--header 'Key: {api-key}' \\\n--header 'Content-Type: application/json' \\\n--data '{\n  \"visibilityPermissions\": {\n    \"permissions\": [\n      {\n        \"type\": \"GLOBAL\",\n        \"ids\": [\"1\"]\n      }\n    ]\n  }\n}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"54-delete-account","__idx":25},"children":["5.4 Delete Account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/account?id={id}&clientId={clientId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Removes an account from a specified client (space)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"query-parameter-3","__idx":26},"children":["Query Parameter"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Required/Optional"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required/Optional"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unique ID of the account added in Sprinklr."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["clientId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Client/space ID from which to remove the account (positive integer)."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"steps-to-extract-account-id-from-sprinklr-ui-3","__idx":27},"children":["Steps to Extract Account ID from Sprinklr UI"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Navigate to ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["All Settings"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Accounts"]}," page."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Locate the account you want."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["three‑dot icon"]}," next to the account name."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Details"]}," from the dropdown. A third‑pane window opens."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the window, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["copy URL icon"]}," at the top right."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Paste the copied URL into any encoder/decoder tool."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The account ID will appear in the decoded URL."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example:"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"If the decoded URL contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/ACCOUNT/100426226/OVERVIEW"]},", then the account ID is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["100426226"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example--request-3","__idx":28},"children":["Example — Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl --location --request DELETE 'https://api3.sprinklr.com/api/v3/account?id=2378712&clientId=108' \\\n--header 'Authorization: Bearer {Enter Your Access Token}' \\\n--header 'Key: {api-key}' \\\n--header 'Accept: application/json'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"6-response-format--status-codes","__idx":29},"children":["6. Response Format & Status Codes"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"61-envelope","__idx":30},"children":["6.1 Envelope"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": Object | Array | String | Boolean,\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example--response-fetch-account","__idx":31},"children":["Example — Response (Fetch Account)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"data\": [\n    {\n      \"id\": \"66000053\",\n      \"type\": \"SPR_ANNOUNCEMENT\",\n      \"displayName\": \"Announcement\",\n      \"channelId\": \"66000000_SPR_ANNOUNCEMENT\",\n      \"owner\": 0,\n      \"channelType\": \"SPRINKLR\",\n      \"spaceId\": 66000002,\n      \"partnerCustomProperties\": {\n        \"_c_6a1de4ab34f417401396e8cc\": [\"BMW\"],\n        \"_c_6a1de4e434f417401396f5f9\": [\"45\"]\n      },\n      \"visibility\": {\n        \"globallyVisible\": false,\n        \"visibilityConfig\": [\n          { \"type\": \"GLOBAL\" }\n        ]\n      },\n      \"permissions\": [\n        { \"type\": \"GLOBAL\", \"ids\": [\"1\", \"78\", \"69\"] }\n      ],\n      \"active\": true,\n      \"deactivationReason\": \"\",\n      \"deleted\": false,\n      \"createdTime\": \"2024-06-26 12:36:41\",\n      \"modifiedTime\": \"2025-08-21 06:41:08\"\n    }\n  ],\n  \"errors\": []\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-parameters","__idx":32},"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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sub‑Param"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sub‑Param"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Definition"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Definition"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["id"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unique account ID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of account. Example: TWITTER, LINKEDIN, FBPAGE"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["displayName"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The display name on the social account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["channelId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The unique ID of the channel where the account exists"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["owner"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Refers to user ID of the account owner"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Integer"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["properties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object defining the different properties (attributes) of the account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["channelType"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The respective channel type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["spaceId"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The client ID related to the account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["clientCustomProperties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Workspace‑level custom properties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["partnerCustomProperties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Global‑level custom properties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["visibility"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object containing account sharing (visibility) details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Object"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["globallyVisible"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines whether the account is globally visible or not"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["shareConfigs"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The object containing details of account sharing configuration"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array defining the details of different permissions on the account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["permalink"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account URL"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["URL"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["active"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines whether the account is active or not"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["deleted"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Determines whether the account is deleted or not"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Boolean"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["deactivationReason"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["If deactivated, determines the reason of account deactivation"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["createdTime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The time when the account was created"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["modifiedTime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The time when the account was last modified"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"array-details-for-permissions-and-shareconfigs","__idx":33},"children":["Array Details for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["permissions"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shareConfigs"]}]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Parameter"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Definition"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Definition"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Type"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The type of permission/shareConfig"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["String"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ids"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["IDs related to the mentioned type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List [String]"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"notes","__idx":34},"children":["Notes"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fetch Account API"]}," returns a JSON object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Update, Patch, and Delete APIs"]},", the response is always:"]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"204 No Content\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"62-response-codes","__idx":35},"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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Code"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Scenario"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scenario"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["200 OK"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operation executed successfully; resource returned"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["204 No Content"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Success (Update/Delete)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Resource updated or deleted successfully"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["400 Bad Request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid Parameters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing required parameters or invalid parameter combinations"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["401 Unauthorized"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication Failed"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid or missing Authorization token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["403 Forbidden"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Insufficient Permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["User lacks permission to perform the operation"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["404 Not Found"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Resource Missing"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Business Hours or Holiday List not found"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["500 Internal Server Error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Server Error"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unexpected server-side error occurred"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"7-migration-from-v2-to-v3","__idx":36},"children":["7. Migration from V2 to V3"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Account APIs have been streamlined in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V3"]}," for consistency and lifecycle control.",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Below is a comparison of ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 vs V3 endpoints and behavior"]},":"]},{"$$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":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Operation"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V2 Endpoint"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V2 Endpoint"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"V3 Endpoint"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["V3 Endpoint"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Key Differences"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Differences"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fetch Account (by Id)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/account/{id}"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v2/account/{type}/{id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /api/v3/account?id={id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 supported both path by ID and type+ID; V3 consolidates into query parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fully Replace Custom Properties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v2/account/update/{id}/customProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v3/account?id={id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 used ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/update/{id}/customProperties"]},"; V3 uses PUT with query parameter ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Append/Merge Custom Properties"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /api/v2/account/update/{id}/customProperties"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/account?id={id}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 used POST for partial updates; V3 uses PATCH with selective fields."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Update Visibility Permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v2/account/{id}/visibility-permissions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/account?id={id}"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visibilityPermissions"]}," object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 had a dedicated endpoint; V3 consolidates into PATCH with visibilityPermissions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Deactivate Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /api/v2/account/{id}/deactivate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH /api/v3/account?id={id}"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active=false"]}," and optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deactivationReason"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["V2 had a separate deactivate endpoint; V3 uses PATCH with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["active=false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete Account"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Not supported in V2"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /api/v3/account?id={id}&clientId={clientId}"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete is newly supported in V3; requires both ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["clientId"]}," as query parameters."]}]}]}]}]}]},"headings":[{"value":"Account API V3 — Developer Guide","id":"account-api-v3--developer-guide","depth":1},{"value":"1. Overview","id":"1-overview","depth":2},{"value":"2. API Endpoints","id":"2-api-endpoints","depth":2},{"value":"3. Base URL","id":"3-base-url","depth":2},{"value":"4. Authentication & Headers","id":"4-authentication--headers","depth":2},{"value":"5. Account Operations","id":"5-account-operations","depth":2},{"value":"5.1 Fetch Account","id":"51-fetch-account","depth":3},{"value":"Query Parameter","id":"query-parameter","depth":2},{"value":"Steps to Extract Account ID from Sprinklr UI","id":"steps-to-extract-account-id-from-sprinklr-ui","depth":2},{"value":"Example — Request","id":"example--request","depth":2},{"value":"5.2 Fully Update Account","id":"52-fully-update-account","depth":3},{"value":"Query Parameter","id":"query-parameter-1","depth":2},{"value":"Steps to Extract Account ID from Sprinklr UI","id":"steps-to-extract-account-id-from-sprinklr-ui-1","depth":2},{"value":"Request Parameters","id":"request-parameters","depth":2},{"value":"Example — Request","id":"example--request-1","depth":2},{"value":"5.3 Partially Update Account","id":"53-partially-update-account","depth":3},{"value":"Query Parameter","id":"query-parameter-2","depth":2},{"value":"Steps to Extract Account ID from Sprinklr UI","id":"steps-to-extract-account-id-from-sprinklr-ui-2","depth":2},{"value":"Request Parameters","id":"request-parameters-1","depth":2},{"value":"Object: customProperties","id":"object-customproperties","depth":3},{"value":"Object: visibilityPermissions","id":"object-visibilitypermissions","depth":3},{"value":"Object: visibility","id":"object-visibility","depth":3},{"value":"Object: visibilityConfig[] item","id":"object-visibilityconfig-item","depth":3},{"value":"Object: permissions[] item","id":"object-permissions-item","depth":3},{"value":"Example — Request","id":"example--request-2","depth":2},{"value":"5.4 Delete Account","id":"54-delete-account","depth":3},{"value":"Query Parameter","id":"query-parameter-3","depth":2},{"value":"Steps to Extract Account ID from Sprinklr UI","id":"steps-to-extract-account-id-from-sprinklr-ui-3","depth":2},{"value":"Example — Request","id":"example--request-3","depth":2},{"value":"6. Response Format & Status Codes","id":"6-response-format--status-codes","depth":2},{"value":"6.1 Envelope","id":"61-envelope","depth":2},{"value":"Example — Response (Fetch Account)","id":"example--response-fetch-account","depth":3},{"value":"Response Parameters","id":"response-parameters","depth":3},{"value":"Array Details for permissions and shareConfigs","id":"array-details-for-permissions-and-shareconfigs","depth":2},{"value":"Notes","id":"notes","depth":2},{"value":"6.2 Response codes","id":"62-response-codes","depth":3},{"value":"7. Migration from V2 to V3","id":"7-migration-from-v2-to-v3","depth":2}],"frontmatter":{"seo":{"title":"Account API V3 — Developer Guide"}},"lastModified":"2026-08-31T08:19:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/guides/developer-guides-v3/account-api-v3-developer-guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}