Team
Updated
1. Creates a new team
Endpoint: POST /paid/governance/create/team
Request Body :
Field | Type | Required | Description |
organizationId | String | Yes | Unique ID to identify the organization |
name | String | Yes | The display name of the organization |
teamId | String | Yes | Unique ID to identify the team |
userList | List | Yes | User Object: email is mandatory [{"email":"Email_id","role":"Super Admin","permissions":["marketingContent","campaigns","microTrends"]}, ] |
actorUserEmail | String | User Email Who is performing the operation |
curl --location 'https://api3.sprinklr.com/{env}/api/v2/paid/governance/create/team' \
--header 'Authorization: Bearer <your-access-token>' \
--header 'Key: <your-api-key>' \
--header 'accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
"organizationId": "sample-org-id",
"name": "SampleTeam",
"teamId": "sample-team-id",
"userList": [
{
"email": "sample.user@example.com",
"role": "Super Admin",
"permissions": ["marketingContent", "campaigns", "microTrends"]
}
]
}'
2. Delete a team
Endpoint: POST /paid/governance/delete/team?teamId=<teamId>
Query Param
Field | Type | Required | Description |
id | String | Yes | Unique ID to identify the team |
3. Get a team
Endpoint: GET /paid/governance/get/team?teamId=<teamId>
Response :
Field | Type | Required | Description |
organizationId | String | Yes | Unique ID to identify the organization |
name | String | Yes | The display name of the organization |
teamId | String | Yes | Unique ID to identify the team |
userList | List | Yes | User Object: email is mandatory [{"email":"Email_id","role":"Super Admin","permissions":["marketingContent","campaigns","microTrends"]}, ] |
createdAt | Long | epoch Creation Time | |
createdBy | String | Creation User Email |
curl --location 'https://api3.sprinklr.com/{env}/api/v2/paid/governance/get/team?teamId=sample-team-id' \
--header 'Authorization: Bearer <your-access-token>' \
--header 'Key: <your-api-key>' \
--header 'accept: application/json' \
--header 'Content-Type: application/json'
4.Get Team List With User and Account Info
Enpoint : /api/paid/governance/get/teamList?organizationId=amaan1515041Test
Query Param
Field | Type | Required | Description |
organizationId | String | Yes | Unique ID to identify the organization |
start | int | No | Default: 0. Used for pagination. Specifies the starting index for records. start = 10 returns records 10–19 start = 30 returns records 30–39 |
count | int | No | Default 10 |
Sample response :
{
"data": {
"data": [
{
"name": "ARTestOrganization1Test",
"teamId": "amaan151504T1Test",
"organizationId": "amaan1515041Test",
"createdAt": 1749702680617,
"modifiedAt": 1749702730995,
"userList": [
{
"email": "amaan.rehman@sprinklr.com",
"role": "Global Admin"
}
],
"pages": [
{
"accountId": 66003350,
"accountUserId": "967024264749764608",
"currency": "USD",
"accountType": "TWITTER",
"channelType": "TWITTER"
}
],
"adAccounts": [
{
"accountId": 66001284,
"accountUserId": "18ce54wwx23",
"currency": "USD",
"accountType": "TWITTER_AD_ACCOUNT",
"channelType": "TWITTER"
}
]
}
],
"hasMore": false
},
"errors": []
}