Skip to content

Assignment Skills API V3 Developer Guide

1. Overview

The Assignment Skills APIs enable you to manage assignment skill categories and the skills associated with them in Unified Routing. The APIs use resource-based endpoints and standard HTTP methods to create, update, fetch, and delete resources.

OperationResourceMethodPath
Create a skill categorySkill categoryPOST/api/v3/unifiedRouting/skillCategory
Create a skillSkillPOST/api/v3/unifiedRouting/skill
Update a skillSkillPUT/api/v3/unifiedRouting/skill?id={skillId}
Fetch a skill by IDSkillGET/api/v3/unifiedRouting/skill?id={skillId}
Fetch a skill category by IDSkill categoryGET/api/v3/unifiedRouting/skillCategory?id={skillCategoryId}
Delete a skillSkillDELETE/api/v3/unifiedRouting/skill?id={skillId}
Delete a skill categorySkill categoryDELETE/api/v3/unifiedRouting/skillCategory?id={skillCategoryId}

Base URL and environments

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

Replace {env} with the environment identifier for your workspace. Supported values:

prod, prod0, prod2, prod3, prod4, prod5, prod6, prod8, prod11, prod12, prod15, prod16, prod17, prod18, prod19, prod21, prod25

Calling a different environment from the one your credentials belong to returns 401, so confirm the value before you start.

The four resource paths in this family:

https://api3.sprinklr.com/{env}/api/v3/unifiedRouting/skill
https://api3.sprinklr.com/{env}/api/v3/unifiedRouting/skillCategory
https://api3.sprinklr.com/{env}/api/v3/userAssignmentConfig
https://api3.sprinklr.com/{env}/api/v3/userAssignmentSettings

3. Authentication

Include the following headers with API requests, as applicable:

HeaderValueDescription
AuthorizationBearer {token}Authenticates the user with the server.
Key{api-key}Authenticates the application with the server.
Content-Typeapplication/jsonIdentifies the request body format. Required for requests containing a JSON body.
Acceptapplication/jsonIdentifies the acceptable response format.

4. Create operations

4.1 Create an assignment skill category

POST /api/v3/unifiedRouting/skillCategory

Creates a skill category and optionally associates one or more skills with it.

Request body

ParameterSub-parameterRequiredTypeDescription
nameRequiredStringName of the skill category.
descriptionOptionalStringDescription of the skill category.
skillsOptionalArray<Object>Skills to associate with the category.
skillRequired when a skill object is providedStringName of the skill.
descriptionOptionalStringDescription of the skill.

Request

curl -X POST \
  'https://api3.sprinklr.com/{env}/api/v3/unifiedRouting/skillCategory' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'Key: {apiKey}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "name": "Voice Support Skills",
    "description": "Skill category for voice support operations",
    "skills": [
      {
        "skill": "Voice Escalation",
        "description": "Skill used for handling escalated voice interactions"
      },
      {
        "skill": "Premium Customer Support",
        "description": "Skill used for premium customer interactions"
      }
    ]
  }'

Response

{
  "data": {
    "id": "6a8c0175bdcf2ff916a1ca92",
    "name": "Voice Support Skills",
    "description": "Skill category for voice support operations",
    "skills": [
      {
        "skill": "Voice Escalation",
        "description": "Skill used for handling escalated voice interactions",
        "skillCategory": "6a8c0175bdcf2ff916a1ca92",
        "createdTime": 0,
        "modifiedTime": 0
      },
      {
        "skill": "Premium Customer Support",
        "description": "Skill used for premium customer interactions",
        "skillCategory": "6a8c0175bdcf2ff916a1ca92",
        "createdTime": 0,
        "modifiedTime": 0
      }
    ],
    "shareConfigs": []
  },
  "errors": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the created skill category details.
idStringUnique identifier of the skill category.
nameStringName of the skill category.
descriptionStringDescription of the skill category.
skillsArray<Object>Skills associated with the category.
skillsskillStringName of the skill.
descriptionStringDescription of the skill.
skillCategoryStringIdentifier of the associated skill category.
createdTimeEpochTime at which the skill was created.
modifiedTimeEpochTime at which the skill was last modified.
datashareConfigsArraySharing configurations associated with the category.
errorsArrayErrors encountered during request processing, if any.

4.2 Create an assignment skill

POST /api/v3/unifiedRouting/skill

Creates a skill and associates it with an existing skill category.

Request body

ParameterRequiredTypeDescription
skillRequiredStringName of the skill.
descriptionOptionalStringDescription of the skill.
skillCategoryRequiredStringUnique identifier of the category to which the skill belongs.

Request

curl -X POST \
  'https://api3.sprinklr.com/{env}/api/v3/unifiedRouting/skill' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'Key: {apiKey}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "skill": "Voice Escalation",
    "description": "Skill used for handling escalated voice interactions",
    "skillCategory": "{skillCategoryId}"
  }'

Response

{
  "data": {
    "id": "6a8c01bfbdcf2ff916a1d60f",
    "skill": "Voice Escalation",
    "description": "Skill used for handling escalated voice interactions",
    "skillCategory": "6a8c0175bdcf2ff916a1ca92",
    "createdTime": 1787560383360,
    "modifiedTime": 1787560383360
  },
  "errors": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataObjectContains the created skill details.
idStringUnique identifier of the skill.
skillStringName of the skill.
descriptionStringDescription of the skill.
skillCategoryStringIdentifier of the associated skill category.
createdTimeEpochTime at which the skill was created.
modifiedTimeEpochTime at which the skill was last modified.
errorsArrayErrors encountered during request processing, if any.

5. Update operations

5.1 Update an assignment skill

PUT /api/v3/unifiedRouting/skill?id={skillId}

Updates an existing assignment skill.

Query parameters

ParameterRequiredTypeDescription
idRequiredStringUnique identifier of the skill to update.

Request body

ParameterRequiredTypeDescription
skillRequiredStringUpdated name of the skill.
descriptionOptionalStringUpdated description of the skill.
skillCategoryOptionalStringIdentifier of the skill category associated with the skill.

Request

curl -X PUT \
  'https://api3.sprinklr.com/{env}/api/v3/unifiedRouting/skill?id={skillId}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'Key: {apiKey}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "skill": "Updated Voice Escalation",
    "description": "Updated skill for handling escalated voice interactions",
    "skillCategory": "{skillCategoryId}"
  }'

Response

HTTP/1.1 204 No Content

A successful request returns 204 No Content and does not include a response body.

6. Fetch operations

6.1 Fetch an assignment skill by ID

GET /api/v3/unifiedRouting/skill?id={skillId}

Fetches a skill by its unique identifier.

Query parameters

ParameterRequiredTypeDescription
idRequiredStringUnique identifier of the skill to fetch.

Request

curl -X GET \
  'https://api3.sprinklr.com/{env}/api/v3/unifiedRouting/skill?id={skillId}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'Key: {apiKey}' \
  -H 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "6a8c01bfbdcf2ff916a1d60f",
      "skill": "Updated Voice Escalation",
      "description": "Updated skill for handling escalated voice interactions",
      "skillCategory": "6a8c0175bdcf2ff916a1ca92",
      "createdTime": 1787560383360,
      "modifiedTime": 1787568144241
    }
  ],
  "errors": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataArray<Object>Contains the skill details returned by the API.
idStringUnique identifier of the skill.
skillStringName of the skill.
descriptionStringDescription of the skill.
skillCategoryStringIdentifier of the associated skill category.
createdTimeEpochTime at which the skill was created.
modifiedTimeEpochTime at which the skill was last modified.
errorsArrayErrors encountered during request processing, if any.

6.2 Fetch an assignment skill category by ID

GET /api/v3/unifiedRouting/skillCategory?id={skillCategoryId}

Fetches a skill category and all skills associated with it.

Query parameters

ParameterRequiredTypeDescription
idRequiredStringUnique identifier of the skill category to fetch.

Request

curl -X GET \
  'https://api3.sprinklr.com/{env}/api/v3/unifiedRouting/skillCategory?id={skillCategoryId}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'Key: {apiKey}' \
  -H 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "6a8c0175bdcf2ff916a1ca92",
      "name": "Voice Support Skills",
      "description": "Skill category for voice support operations",
      "skills": [
        {
          "id": "6a8c0175e3cf199dffebef49",
          "skill": "Voice Escalation",
          "description": "Skill used for handling escalated voice interactions",
          "skillCategory": "6a8c0175bdcf2ff916a1ca92",
          "createdTime": 1787560309948,
          "modifiedTime": 1787560309948
        },
        {
          "id": "6a8c0175954e42e4747a16d3",
          "skill": "Premium Customer Support",
          "description": "Skill used for premium customer interactions",
          "skillCategory": "6a8c0175bdcf2ff916a1ca92",
          "createdTime": 1787560309981,
          "modifiedTime": 1787560309981
        }
      ],
      "shareConfigs": []
    }
  ],
  "errors": []
}

Response parameters

ParameterSub-parameterTypeDescription
dataArray<Object>Contains the skill category details.
idStringUnique identifier of the skill category.
nameStringName of the skill category.
descriptionStringDescription of the skill category.
skillsArray<Object>Skills associated with the category.
skillsidStringUnique identifier of the skill.
skillStringName of the skill.
descriptionStringDescription of the skill.
skillCategoryStringIdentifier of the associated skill category.
createdTimeEpochTime at which the skill was created.
modifiedTimeEpochTime at which the skill was last modified.
datashareConfigsArraySharing configurations associated with the category.
errorsArrayErrors encountered during request processing, if any.

7. Delete operations

7.1 Delete an assignment skill

DELETE /api/v3/unifiedRouting/skill?id={skillId}

Deletes an existing assignment skill.

Query parameters

ParameterRequiredTypeDescription
idRequiredStringUnique identifier of the skill to delete.

Request

curl -X DELETE \
  'https://api3.sprinklr.com/{env}/api/v3/unifiedRouting/skill?id={skillId}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'Key: {apiKey}' \
  -H 'Accept: application/json'

Response

HTTP/1.1 204 No Content

A successful request returns 204 No Content and does not include a response body.

7.2 Delete an assignment skill category

DELETE /api/v3/unifiedRouting/skillCategory?id={skillCategoryId}

Deletes an existing assignment skill category.

Query parameters

ParameterRequiredTypeDescription
idRequiredStringUnique identifier of the skill category to delete.

Request

curl -X DELETE \
  'https://api3.sprinklr.com/{env}/api/v3/unifiedRouting/skillCategory?id={skillCategoryId}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'Key: {apiKey}' \
  -H 'Accept: application/json'

Response

HTTP/1.1 200 OK

A successful request returns 200 OK and does not include a response body.

Use the APIs in the following order when configuring and managing assignment skills:

  1. Create a skill category.
  2. Create one or more skills and associate them with the category.
  3. Update a skill when its name, description, or category association changes.
  4. Fetch a skill or skill category to retrieve and verify its current configuration.
  5. Delete skills that are no longer required.
  6. Delete a skill category after its associated skills are no longer required.

9. HTTP success responses

OperationSuccess statusResponse body
Create skill categoryResponse object returnedYes
Create skillResponse object returnedYes
Update skill204 No ContentNo
Fetch skillResponse object returnedYes
Fetch skill categoryResponse object returnedYes
Delete skill204 No ContentNo
Delete skill category200 OKNo

Use Cases

TaskCall
Create a skill categoryPOST /unifiedRouting/skillCategory with name
Create a category and its skills togetherPOST /unifiedRouting/skillCategory with a populated skills array
Add one skill to an existing categoryPOST /unifiedRouting/skill with skillCategory set
Look up a skill's id from its nameGET /unifiedRouting/skill?name=Refunds then read data[0].id
List every skill in a categoryGET /unifiedRouting/skillCategory?id={id} then read data[0].skills
Rename a skillPUT /unifiedRouting/skill?id={id} with the full skill object
Move a skill to another categoryPUT /unifiedRouting/skill?id={id} with a new skillCategory
Delete one skillDELETE /unifiedRouting/skill?id={id}
Delete a category and all its skillsDELETE /unifiedRouting/skillCategory?id={id}
Read an agent's skills and capacityGET /userAssignmentConfig?userId={userId} then read data[0]
Grant an agent a skillPATCH /userAssignmentConfig?userId={userId} with proficiencies.skillVsProficiency
Revoke an agent's skillPATCH /userAssignmentConfig?userId={userId} with skillsToRemove
Reset an agent's whole configurationPUT /userAssignmentConfig?userId={userId}

Migrating from API 2.0

If you already use the API 2.0 Skill APIs, every operation you rely on has an API 3.0 equivalent. Your API key, secret and OAuth flow work unchanged — see API Overview.

Two naming changes cause most migration failures

API 3.0 drops kebab-case from path segments entirely. Changing only the version number in your URLs will return 404.

ResourceAPI 2.0API 3.0
Routing rootunified-routingunifiedRouting
Skill categoryskill-categoryskillCategory
Agent configurationuser-settings/assignment-configuserAssignmentConfig