- Applies to: Sprinklr User Assignment Settings API V3 (
/api/v3/userAssignmentSettings)
The User Assignment Settings API enables you to create assignment settings for a user with skill proficiency values and update the skill proficiency settings for an existing user assignment configuration.
| Operation | Method | Path |
|---|---|---|
| Create user assignment settings | POST | /api/v3/userAssignmentSettings/ |
| Update user assignment settings | PUT | /api/v3/userAssignmentSettings?userId={userId} |
All API calls use the following base URL:
https://api3.sprinklr.com/{env}/api/v3So the User Assignment Settings API in production is:
https://api3.sprinklr.com/{env}/api/v3/userAssignmentSettings Replace {env} with your assigned Sprinklr environment.
API headers include the mandatory information sent with the request URL and body. This information provides the request context and authorisation credentials required to access protected resources.
| Header | Value | Description | Required on |
|---|---|---|---|
| Authorization | Bearer {token} | Credential used by the API to authenticate a user with the server. | POST, PUT |
| Key | api-key | API key used to authenticate the application with the server. | POST, PUT |
| Content-Type | application/json | Identifies the media type of the request body. | POST, PUT |
| Accept | application/json | Determines the acceptable response type from the server. | POST, PUT |
POST /api/v3/userAssignmentSettings/
Creates assignment settings for a user with skill proficiency values.
| Parameter | Required | Type | Description |
|---|---|---|---|
| userId | Required | String | Unique identifier of the user. |
| skillVsProficiency | Required | Object | Maps skill IDs to their proficiency scores. Each object key is a skill ID and its value is the corresponding proficiency score. |
curl -X POST \
'https://api3.sprinklr.com/{env}/api/v3/userAssignmentSettings/' \
-H 'Authorization: Bearer {Enter your Access Token}' \
-H 'Key: {Enter your API KEY}' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"userId": "66007876",
"skillVsProficiency": {
"5ede78c522098613e5dfd9c9": 77,
"5fbfc48accb38e37b031cb65": 57
}
}'{
"data": {
"userId": "66007876",
"capacities": [],
"proficiencies": {
"skillVsProficiency": {
"5fbfc48accb38e37b031cb65": 57,
"5ede78c522098613e5dfd9c9": 77
}
}
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
| data | Object | Contains the created user assignment settings. | |
| userId | String | Unique identifier of the user. | |
| capacities | Array | List of capacity configurations assigned to the user. | |
| proficiencies | Object | Contains the user proficiency configuration. | |
| proficiencies | skillVsProficiency | Object | Maps skill IDs to their proficiency scores. |
| errors | Array | Contains errors encountered during request processing, if any. |
PUT /api/v3/userAssignmentSettings?userId={userId}
Updates skill proficiency settings for an existing user assignment configuration.
| Parameter | Required | Type | Description |
|---|---|---|---|
| userId | Required | String | Unique identifier of the user whose assignment settings are updated. |
| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
| skillVsProficiency | Required | Object | Maps skill IDs to their updated proficiency scores. | |
| skillId | Required | String | Unique identifier of the skill. Use the skill ID as the object key. | |
| proficiencyScore | Required | Integer | Updated proficiency score used as the value for the specified skill ID. |
curl -X PUT \
'https://api3.sprinklr.com/{env}/api/v3/userAssignmentSettings?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 '{
"skillVsProficiency": {
"5ede78c522098613e5dfd9c9": 78,
"5fbfc48accb38e37b031cb65": 53
}
}'HTTP/1.1 204 No ContentThe API does not return a response body following successful execution.
| Parameter | Description | Type |
|---|---|---|
| HTTP Status Code | Indicates the result of the update operation. | Integer |
| 204 No Content | Indicates that the user assignment settings were successfully updated. | Status Code |
When onboarding a new user into an assignment workflow:
Create a User Assignment Settings record.
Associate skills with proficiency values.
Store the returned configuration.
This establishes the user's initial routing profile.
As users gain expertise:
Submit a PUT request.
Update relevant proficiency values.
Apply revised routing preferences.
This allows assignment systems to reflect changing user capabilities.
Assignment engines can use skill proficiency mappings when determining which users are most qualified to receive incoming work.
Example workflow:
Identify required work skills.
Retrieve user assignment settings through internal assignment systems.
Compare proficiency scores.
Assign work to the most suitable users.