Skip to content
Last updated

User Assignment Settings API V3 — Developer Guide

  • Applies to: Sprinklr User Assignment Settings API V3 (/api/v3/userAssignmentSettings)

1. Overview

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.

OperationMethodPath
Create user assignment settingsPOST/api/v3/userAssignmentSettings/
Update user assignment settingsPUT/api/v3/userAssignmentSettings?userId={userId}

2. Base URL and environment

All API calls use the following base URL:

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

So the User Assignment Settings API in production is:

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

Replace {env} with your assigned Sprinklr environment.

3. Authentication and common headers

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.

HeaderValueDescriptionRequired on
AuthorizationBearer {token}Credential used by the API to authenticate a user with the server.POST, PUT
Keyapi-keyAPI key used to authenticate the application with the server.POST, PUT
Content-Typeapplication/jsonIdentifies the media type of the request body.POST, PUT
Acceptapplication/jsonDetermines the acceptable response type from the server.POST, PUT

4. Write operations

4.1 Create user assignment settings

POST /api/v3/userAssignmentSettings/

Creates assignment settings for a user with skill proficiency values.

Request parameters

ParameterRequiredTypeDescription
userIdRequiredStringUnique identifier of the user.
skillVsProficiencyRequiredObjectMaps skill IDs to their proficiency scores. Each object key is a skill ID and its value is the corresponding proficiency score.

Request

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
    }
  }'

Response

{
  "data": {
    "userId": "66007876",
    "capacities": [],
    "proficiencies": {
      "skillVsProficiency": {
        "5fbfc48accb38e37b031cb65": 57,
        "5ede78c522098613e5dfd9c9": 77
      }
    }
  },
  "errors": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the created user assignment settings.
userIdStringUnique identifier of the user.
capacitiesArrayList of capacity configurations assigned to the user.
proficienciesObjectContains the user proficiency configuration.
proficienciesskillVsProficiencyObjectMaps skill IDs to their proficiency scores.
errorsArrayContains errors encountered during request processing, if any.

4.2 Update user assignment settings

PUT /api/v3/userAssignmentSettings?userId={userId}

Updates skill proficiency settings for an existing user assignment configuration.

Query parameters

ParameterRequiredTypeDescription
userIdRequiredStringUnique identifier of the user whose assignment settings are updated.

Request body

ParameterSub-parameterRequiredTypeDescription
skillVsProficiencyRequiredObjectMaps skill IDs to their updated proficiency scores.
skillIdRequiredStringUnique identifier of the skill. Use the skill ID as the object key.
proficiencyScoreRequiredIntegerUpdated proficiency score used as the value for the specified skill ID.

Request

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
    }
  }'

Response

HTTP/1.1 204 No Content

The API does not return a response body following successful execution.

Response parameters

ParameterDescriptionType
HTTP Status CodeIndicates the result of the update operation.Integer
204 No ContentIndicates that the user assignment settings were successfully updated.Status Code

7. Use Cases

Configure New User Skills

When onboarding a new user into an assignment workflow:

  1. Create a User Assignment Settings record.

  2. Associate skills with proficiency values.

  3. Store the returned configuration.

This establishes the user's initial routing profile.


Update User Expertise

As users gain expertise:

  1. Submit a PUT request.

  2. Update relevant proficiency values.

  3. Apply revised routing preferences.

This allows assignment systems to reflect changing user capabilities.


Skill-Based Work Distribution

Assignment engines can use skill proficiency mappings when determining which users are most qualified to receive incoming work.

Example workflow:

  1. Identify required work skills.

  2. Retrieve user assignment settings through internal assignment systems.

  3. Compare proficiency scores.

  4. Assign work to the most suitable users.