Account API V3 — Developer Guide

• Applies to: Sprinklr Account API V3
• V2 API reference: Account API | Sprinklr Developer Portal

An account refers to the brand’s social media account that has been successfully added to Sprinklr. Once added, you can view, edit, update, delete, or deactivate the account.

📖 Related Knowledge Base Article: Account

All API calls are sent to:

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

So the Account resource in production is:

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

Replace {env} with your assigned environment identifier (prod0, prod2, prod11, etc.).

GET /api/v3/account?id={id}

Retrieves account details using its unique ID.

1. Navigate to All Settings.
2. Open the Accounts page.
3. Locate the account you want.
4. Click the three‑dot icon next to the account name.
5. Select Details from the dropdown. A third‑pane window opens.
6. In the window, click the copy URL icon at the top right.
7. Paste the copied URL into any encoder/decoder tool.
8. The account ID will appear in the decoded URL.

Example:
If the decoded URL contains /ACCOUNT/100426226/OVERVIEW, then the account ID is 100426226.

curl --location --request GET 'https://api3.sprinklr.com/{env}/api/v3/account?id=66000053' \
--header 'Authorization: {Enter your Access Token}' \
--header 'Key: {Enter your API KEY}' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \

PUT /api/v3/account?id={id}

Replaces all custom properties on an account.

1. Navigate to All Settings.
2. Open the Accounts page.
3. Locate the account you want.
4. Click the three‑dot icon next to the account name.
5. Select Details from the dropdown. A third‑pane window opens.
6. In the window, click the copy URL icon at the top right.
7. Paste the copied URL into any encoder/decoder tool.
8. The account ID will appear in the decoded URL.

Example:
If the decoded URL contains /ACCOUNT/100426226/OVERVIEW, then the account ID is 100426226.

curl --location --request PUT 'https://api3.sprinklr.com/{env}/api/v3/account?id=66000053' \
--header 'Authorization: {Enter Your Access Token}' \
--header 'Key: {Enter Your API Key}' \
--header 'Content-Type: application/json' \
--data '{
    "spaceId": 66000002,
    "clientCustomProperties": {
        "region": ["US"]
    },
    "partnerCustomProperties": {
        "tier": ["gold"]
    }
}'

PATCH /api/v3/account?id={id}

Updates account details without overwriting the entire object. Supports appending/merging custom properties, updating visibility/permissions, or deactivating an account.

1. Navigate to All Settings.
2. Open the Accounts page.
3. Locate the account you want.
4. Click the three‑dot icon next to the account name.
5. Select Details from the dropdown. A third‑pane window opens.
6. In the window, click the copy URL icon at the top right.
7. Paste the copied URL into any encoder/decoder tool.
8. The account ID will appear in the decoded URL.

Example:
If the decoded URL contains /ACCOUNT/100426226/OVERVIEW, then the account ID is 100426226.

curl --location --request PATCH 'https://api3.sprinklr.com/{env}/api/v3/account?id=66000053' \
--header 'Authorization: {Enter Your Access Token}' \
--header 'Key: {api-key}' \
--header 'Content-Type: application/json' \
--data '{
  "visibilityPermissions": {
    "permissions": [
      {
        "type": "GLOBAL",
        "ids": ["1"]
      }
    ]
  }
}'

DELETE /api/v3/account?id={id}&clientId={clientId}

Removes an account from a specified client (space).

1. Navigate to All Settings.
2. Open the Accounts page.
3. Locate the account you want.
4. Click the three‑dot icon next to the account name.
5. Select Details from the dropdown. A third‑pane window opens.
6. In the window, click the copy URL icon at the top right.
7. Paste the copied URL into any encoder/decoder tool.
8. The account ID will appear in the decoded URL.

Example:
If the decoded URL contains /ACCOUNT/100426226/OVERVIEW, then the account ID is 100426226.

curl --location --request DELETE 'https://api3.sprinklr.com/api/v3/account?id=2378712&clientId=108' \
--header 'Authorization: Bearer {Enter Your Access Token}' \
--header 'Key: {api-key}' \
--header 'Accept: application/json'

{
  "data": Object | Array | String | Boolean,
  "errors": []
}

{
  "data": [
    {
      "id": "66000053",
      "type": "SPR_ANNOUNCEMENT",
      "displayName": "Announcement",
      "channelId": "66000000_SPR_ANNOUNCEMENT",
      "owner": 0,
      "channelType": "SPRINKLR",
      "spaceId": 66000002,
      "partnerCustomProperties": {
        "_c_6a1de4ab34f417401396e8cc": ["BMW"],
        "_c_6a1de4e434f417401396f5f9": ["45"]
      },
      "visibility": {
        "globallyVisible": false,
        "visibilityConfig": [
          { "type": "GLOBAL" }
        ]
      },
      "permissions": [
        { "type": "GLOBAL", "ids": ["1", "78", "69"] }
      ],
      "active": true,
      "deactivationReason": "",
      "deleted": false,
      "createdTime": "2024-06-26 12:36:41",
      "modifiedTime": "2025-08-21 06:41:08"
    }
  ],
  "errors": []
}

• Fetch Account API returns a JSON object with data and errors.

• For Update, Patch, and Delete APIs, the response is always:

204 No Content

The Account APIs have been streamlined in V3 for consistency and lifecycle control.
Below is a comparison of V2 vs V3 endpoints and behavior: