Skip to content
Last updated

User Assignment Configuration API

1. Overview

The User Assignment Settings Config API enables you to create, update, and fetch a user's assignment configuration, including capacity and proficiency settings.

OperationMethodEndpoint
Create User Assignment ConfigPOST/api/v3/userAssignmentConfig
Update User Assignment ConfigPUT/api/v3/userAssignmentConfig?userId={userId}
Update User Assignment ConfigPATCH/api/v3/userAssignmentConfig?userId={userId}
Fetch User Assignment ConfigGET/api/v3/userAssignmentConfig?userId={userId}

Base URL

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 

3. Authentication and common headers

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

4. API operations

4.1 Create User Assignment Config

POST /api/v3/userAssignmentConfig

Use this API to create a user assignment configuration with capacity and proficiency settings.

Request parameters

ParameterSub-parameterRequired/OptionalDescriptionType
userIdRequiredUnique identifier of the user.String
capacitiesRequiredList of capacity configurations assigned to the user.Array<Object>
idRequiredUnique identifier of the capacity configuration.String
capacityRequiredMaximum work capacity configured for the user.Integer
activeConversationCapacityRequiredMaximum number of active conversations the user can handle.Integer
proficienciesRequiredContains the user proficiency configuration.Object
skillVsProficiencyOptionalMaps skill IDs to their proficiency scores.Object
languageVsProficiencyOptionalMaps language codes to their proficiency scores.Object
channelVsProficiencyOptionalMaps channels to their proficiency scores.Object
capacityConfigIdRequiredUnique identifier of the capacity configuration.String

Example request

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

Example response

{
  "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": []
}

Response parameters

ParameterSub-parameterDescriptionType
dataContains the created user assignment configuration.Object
userIdUnique identifier of the user.String
capacitiesList of capacity configurations assigned to the user.Array<Object>
capacitiesidUnique identifier of the capacity configuration.String
capacityMaximum work capacity configured for the user.Integer
activeConversationCapacityMaximum number of active conversations the user can handle.Integer
dataproficienciesContains the user proficiency configuration.Object
proficienciesskillVsProficiencyMaps skill IDs to their proficiency scores.Object
languageVsProficiencyMaps language codes to their proficiency scores.Object
channelVsProficiencyMaps channels to their proficiency scores.Object
datacapacityConfigIdUnique identifier of the capacity configuration.String
errorsContains errors encountered during request processing, if any.Array

4.2 Update User Assignment Config using PUT

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

Use this API to update an existing user assignment configuration.

Query parameters

ParameterRequired/OptionalDescriptionType
userIdRequiredUnique identifier of the user whose assignment configuration is updated.String

Request parameters

ParameterSub-parameterRequired/OptionalDescriptionType
userIdRequiredUnique identifier of the user.String
proficienciesRequiredContains the proficiency settings to update.Object
skillVsProficiencyRequiredMaps skill IDs to their updated proficiency scores.Object

Example request

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

Example response

HTTP/1.1 204 No Content

This API does not return a response body on successful execution.

4.3 Update User Assignment Config using PATCH

PATCH /api/v3/userAssignmentConfig?userId={userId}

Use this API to update selected capacity or proficiency settings in an existing user assignment configuration.

Query parameters

ParameterRequired/OptionalDescriptionType
userIdRequiredUnique identifier of the user whose assignment configuration is updated.String

Request parameters

ParameterSub-parameterRequired/OptionalDescriptionType
capacitiesOptionalList of capacity configurations to update for the user.Array<Object>
idRequiredUnique identifier of the capacity configuration.String
capacityOptionalUpdated maximum work capacity for the user.Integer
activeConversationCapacityOptionalUpdated maximum number of active conversations the user can handle.Integer
proficienciesOptionalContains the proficiency settings to update.Object
skillVsProficiencyOptionalMaps skill IDs to their updated proficiency scores.Object

Example request

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

Example response

HTTP/1.1 204 No Content

This API does not return a response body on successful execution.

4.4 Fetch User Assignment Config

GET /api/v3/userAssignmentConfig?userId={userId}

Use this API to fetch the assignment configuration for a specific user.

Query parameters

ParameterRequired/OptionalDescriptionType
userIdRequiredUnique identifier of the user whose assignment configuration is fetched.String

Example request

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'

Example response

{
  "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": []
}

Response parameters

ParameterSub-parameterDescriptionType
dataContains the user assignment configuration details.Array
userIdUnique identifier of the user.String
capacitiesList of capacity configurations assigned to the user.Array<Object>
capacitiesidUnique identifier of the capacity configuration.String
capacityMaximum work capacity configured for the user.Integer
activeConversationCapacityMaximum number of active conversations the user can handle.Integer
dataproficienciesContains the user proficiency configuration.Object
proficienciesskillVsProficiencyMaps skill IDs to their proficiency scores.Object
languageVsProficiencyMaps language codes to their proficiency scores.Object
channelVsProficiencyMaps channels to their proficiency scores.Object
datacapacityConfigIdUnique identifier of the capacity configuration.String
errorsContains errors encountered during request processing, if any.Array

5. Use Cases

Create User Routing Configuration

Create a configuration when onboarding a new user into assignment workflows:

  1. Create capacity settings.

  2. Define active conversation limits.

  3. Configure skill proficiencies.

  4. Configure language proficiencies.

  5. Associate a capacity configuration.


Retrieve Assignment Eligibility

Fetch a user's assignment configuration before assigning work.

Workflow:

  1. Call GET with the user ID.

  2. Read capacities.

  3. Review proficiency mappings.

  4. Determine assignment eligibility.


Increase Work Capacity

When a user becomes available for additional workload:

  1. Submit a PATCH request.

  2. Update capacity values.

  3. Preserve existing proficiency settings.


Update Skill Scores

When user expertise changes:

  1. Send a PUT request.

  2. Update skill proficiency mappings.

  3. Verify configuration using GET.