Account Management
Updated
1. Add Account
FB_AD_ACCOUNT, FBPAGE,
LINKEDIN_AD_ACCOUNT,
LINKEDIN_COMPANY,
TWITTER_AD_ACCOUNT,
TWITTER,
TIKTOK_AD_ACCOUNT
GET /paid/governance/get/authorizedUrl
Returns an authorized URL for account addition, based on provided organization, team, and user context. This endpoint is part of the Paid Governance API.
Query Parameters
Name | Type | Required | Description |
organizationId | String | Yes | Unique ID of the organization |
teamId | String | Yes | Unique ID of the team |
accountType | String | Yes | |
userEmail | String | Yes | Email of the requesting user |
GET /get/authorizedUrl?organizationId=123&teamId=456&userEmail=user@example.com
Open Returned Url In Browser and Do Native Authenctication
curl --location 'https://api3.sprinklr.com/{env}/api/v2/paid/governance/get/authorizedUrl?organizationId=sample-org-id&teamId=sample-team-id&userEmail=sample.user%40example.com&accountType=TWITTER_AD_ACCOUNT' \--header 'Authorization: Bearer <your-access-token>' \--header 'Key: <your-api-key>' \--header 'accept: application/json' \--header 'Content-Type: application/json'
For Instagram Page addition,
You don’t need to add Instagram pages separately since they’re already linked to the Facebook page. When you add the Facebook page, the associated Instagram pages are automatically synced and added.
Use the following API to fetch all Instagram pages linked to that Facebook page.
Endpoint: POST /paid/resource/instagram/accounts
Query Parameters
Name | Type | Required | Description |
accountUserId | String | Yes | Ad Account accountUserId |
pageId | String | Yes | Page Account accountUserId |
Response
{"data": {"userAccountDTOS": [{"account": {"accountId": 1239623403,"accountType": "INSTAGRAM","accountUserId": "17841459127859912","screenName": "soulartistic1234","displayName": "soulartistic1234","isActive": true,"snType": "INSTAGRAM","isDeleted": false,"profileImgUrl": "https://...","pageId": "133777779825243","report": "ACCOUNT"},"type": "FB_PAGE_SUPPORTED","properties": {"instagramBusinessAccountId": "17841459127859912"}}]},"errors": []}
2. Attach an Ad Account to a team.
POST /paid/governance/attach/adAccount
Query Parameters
Name | Type | Required | Description |
teamId | String | Yes | Team to which account is attached |
accountId | Long | Yes | Ad account to be attached |
Response
true or false (plain text)
curl --location --request POST 'https://api3.sprinklr.com/{env}/api/v2/paid/governance/attach/adAccount?teamId=sample-team-id&accountId=sample-ad-account-id' \--header 'Authorization: Bearer <your-access-token>' \--header 'Key: <your-api-key>' \--header 'accept: application/json' \--header 'Content-Type: application/json'
3. Remove an Ad Account from a team.
POST /paid/governance/remove/adAccount
Query Parameters
Name | Type | Required | Description |
teamId | String | Yes | Team from which account is removed |
accountId | Long | Yes | Ad account to be removed |
Response
true or false (plain text)
4. Attach an Page Account to a team.
POST /paid/governance/attach/pageAccount
Query Parameters
Name | Type | Required | Description |
teamId | String | Yes | Team to which account is attached |
accountId | Long | Yes | Page account to be attached |
Response
true or false (plain text)
curl --location --request POST 'https://api3.sprinklr.com/{env}/api/v2/paid/governance/attach/pageAccount?teamId=sample-team-id&accountId=sample-page-account-id' \--header 'Authorization: Bearer <your-access-token>' \--header 'Key: <your-api-key>' \--header 'accept: application/json' \--header 'Content-Type: application/json'
4. Remove Page Account from a team.
🔗 POST /paid/governance/remove/pageAccount
Query Parameters
Name | Type | Required | Description |
teamId | String | Yes | Team from which account is removed |
accountId | Long | Yes | Page account to be removed |
Response
true or false (plain text)