The User Assignment Settings Config API enables you to create, update, and fetch a user's assignment configuration, including capacity and proficiency settings.
| Operation | Method | Endpoint |
|---|---|---|
| Create User Assignment Config | POST | /api/v3/userAssignmentConfig |
| Update User Assignment Config | PUT | /api/v3/userAssignmentConfig?userId={userId} |
| Update User Assignment Config | PATCH | /api/v3/userAssignmentConfig?userId={userId} |
| Fetch User Assignment Config | GET | /api/v3/userAssignmentConfig?userId={userId} |
https://api3.sprinklr.com/{env}/api/v3/userAssignmentConfig Replace {env} with your assigned Sprinklr environment.
Examples:
https://api3.sprinklr.com/prod/api/v3/userAssignmentConfig
https://api3.sprinklr.com/prod2/api/v3/userAssignmentConfig | Key | Value | Description |
|---|---|---|
| Authorization | Bearer {token} | Credential used by the API to authenticate a user with the server. |
| Key | api-key | API key used to authenticate the application with the server. |
| Content-Type | application/json | Determines the media type of the request body. |
| Accept | application/json | Determines the acceptable response type from the server. |
POST /api/v3/userAssignmentConfig
Use this API to create a user assignment configuration with capacity and proficiency settings.
| Parameter | Sub-parameter | Required/Optional | Description | Type |
|---|---|---|---|---|
| userId | Required | Unique identifier of the user. | String | |
| capacities | Required | List of capacity configurations assigned to the user. | Array<Object> | |
| id | Required | Unique identifier of the capacity configuration. | String | |
| capacity | Required | Maximum work capacity configured for the user. | Integer | |
| activeConversationCapacity | Required | Maximum number of active conversations the user can handle. | Integer | |
| proficiencies | Required | Contains the user proficiency configuration. | Object | |
| skillVsProficiency | Optional | Maps skill IDs to their proficiency scores. | Object | |
| languageVsProficiency | Optional | Maps language codes to their proficiency scores. | Object | |
| channelVsProficiency | Optional | Maps channels to their proficiency scores. | Object | |
| capacityConfigId | Required | Unique identifier of the capacity configuration. | String |
curl -X POST \
'https://api3.sprinklr.com/{env}/api/v3/userAssignmentConfig' \
-H 'Authorization: Bearer {Enter your Access Token}' \
-H 'Key: {Enter your API KEY}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"userId": "66007877",
"capacities": [
{
"id": "default",
"capacity": 2,
"activeConversationCapacity": 3
}
],
"proficiencies": {
"skillVsProficiency": {
"5fbfc48accb38e37b031cb65": 43,
"5ede78c522098613e5dfd9c9": 57,
"5ee78b36861c7b3cc829b706": 26
},
"languageVsProficiency": {
"en": 90
},
"channelVsProficiency": {}
},
"capacityConfigId": "64e5bea1cf307e061ae891b4"
}'{
"data": {
"userId": "66007877",
"capacities": [
{
"id": "default",
"capacity": 2,
"activeConversationCapacity": 3
}
],
"proficiencies": {
"skillVsProficiency": {
"5fbfc48accb38e37b031cb65": 43,
"5ede78c522098613e5dfd9c9": 57,
"5ee78b36861c7b3cc829b706": 26
},
"languageVsProficiency": {
"en": 90
},
"channelVsProficiency": {}
},
"capacityConfigId": "64e5bea1cf307e061ae891b4"
},
"errors": []
}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains the created user assignment configuration. | Object | |
| userId | Unique identifier of the user. | String | |
| capacities | List of capacity configurations assigned to the user. | Array<Object> | |
| capacities | id | Unique identifier of the capacity configuration. | String |
| capacity | Maximum work capacity configured for the user. | Integer | |
| activeConversationCapacity | Maximum number of active conversations the user can handle. | Integer | |
| data | proficiencies | Contains the user proficiency configuration. | Object |
| proficiencies | skillVsProficiency | Maps skill IDs to their proficiency scores. | Object |
| languageVsProficiency | Maps language codes to their proficiency scores. | Object | |
| channelVsProficiency | Maps channels to their proficiency scores. | Object | |
| data | capacityConfigId | Unique identifier of the capacity configuration. | String |
| errors | Contains errors encountered during request processing, if any. | Array |
PUT /api/v3/userAssignmentConfig?userId={userId}
Use this API to update an existing user assignment configuration.
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| userId | Required | Unique identifier of the user whose assignment configuration is updated. | String |
| Parameter | Sub-parameter | Required/Optional | Description | Type |
|---|---|---|---|---|
| userId | Required | Unique identifier of the user. | String | |
| proficiencies | Required | Contains the proficiency settings to update. | Object | |
| skillVsProficiency | Required | Maps skill IDs to their updated proficiency scores. | Object |
curl -X PUT \
'https://api3.sprinklr.com/{env}/api/v3/userAssignmentConfig?userId={userId}' \
-H 'Authorization: Bearer {Enter your Access Token}' \
-H 'Key: {Enter your API KEY}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"userId": "66007877",
"proficiencies": {
"skillVsProficiency": {
"5f6992783f0c3d580df821b4": 197
}
}
}'HTTP/1.1 204 No ContentThis API does not return a response body on successful execution.
PATCH /api/v3/userAssignmentConfig?userId={userId}
Use this API to update selected capacity or proficiency settings in an existing user assignment configuration.
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| userId | Required | Unique identifier of the user whose assignment configuration is updated. | String |
| Parameter | Sub-parameter | Required/Optional | Description | Type |
|---|---|---|---|---|
| capacities | Optional | List of capacity configurations to update for the user. | Array<Object> | |
| id | Required | Unique identifier of the capacity configuration. | String | |
| capacity | Optional | Updated maximum work capacity for the user. | Integer | |
| activeConversationCapacity | Optional | Updated maximum number of active conversations the user can handle. | Integer | |
| proficiencies | Optional | Contains the proficiency settings to update. | Object | |
| skillVsProficiency | Optional | Maps skill IDs to their updated proficiency scores. | Object |
curl -X PATCH \
'https://api3.sprinklr.com/{env}/api/v3/userAssignmentConfig?userId={userId}' \
-H 'Authorization: Bearer {Enter your Access Token}' \
-H 'Key: {Enter your API KEY}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"capacities": [
{
"id": "default",
"capacity": 4,
"activeConversationCapacity": 3
}
],
"proficiencies": {
"skillVsProficiency": {
"5ede78c522098613e5dfd9c9": 59,
"5ee78b36861c7b3cc829b706": 27,
"5fbfc48accb38e37b031cb65": 45
}
}
}'HTTP/1.1 204 No ContentThis API does not return a response body on successful execution.
GET /api/v3/userAssignmentConfig?userId={userId}
Use this API to fetch the assignment configuration for a specific user.
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
| userId | Required | Unique identifier of the user whose assignment configuration is fetched. | String |
curl -X GET \
'https://api3.sprinklr.com/{env}/api/v3/userAssignmentConfig?userId={userId}' \
-H 'Authorization: Bearer {Enter your Access Token}' \
-H 'Key: {Enter your API KEY}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'{
"data": [
{
"userId": "660078631",
"capacities": [
{
"id": "default",
"capacity": 2,
"activeConversationCapacity": 2
}
],
"proficiencies": {
"skillVsProficiency": {
"5fbfc48accb38e37b031cb65": 42,
"5ede78c522098613e5dfd9c9": 56,
"5ee78b36861c7b3cc829b706": 25
},
"languageVsProficiency": {
"en": 90
},
"channelVsProficiency": {}
},
"capacityConfigId": "64e5bea1cf307e061ae891b4"
}
],
"errors": []
}| Parameter | Sub-parameter | Description | Type |
|---|---|---|---|
| data | Contains the user assignment configuration details. | Array | |
| userId | Unique identifier of the user. | String | |
| capacities | List of capacity configurations assigned to the user. | Array<Object> | |
| capacities | id | Unique identifier of the capacity configuration. | String |
| capacity | Maximum work capacity configured for the user. | Integer | |
| activeConversationCapacity | Maximum number of active conversations the user can handle. | Integer | |
| data | proficiencies | Contains the user proficiency configuration. | Object |
| proficiencies | skillVsProficiency | Maps skill IDs to their proficiency scores. | Object |
| languageVsProficiency | Maps language codes to their proficiency scores. | Object | |
| channelVsProficiency | Maps channels to their proficiency scores. | Object | |
| data | capacityConfigId | Unique identifier of the capacity configuration. | String |
| errors | Contains errors encountered during request processing, if any. | Array |
Create a configuration when onboarding a new user into assignment workflows:
Create capacity settings.
Define active conversation limits.
Configure skill proficiencies.
Configure language proficiencies.
Associate a capacity configuration.
Fetch a user's assignment configuration before assigning work.
Workflow:
Call GET with the user ID.
Read capacities.
Review proficiency mappings.
Determine assignment eligibility.
When a user becomes available for additional workload:
Submit a PATCH request.
Update capacity values.
Preserve existing proficiency settings.
When user expertise changes:
Send a PUT request.
Update skill proficiency mappings.
Verify configuration using GET.