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.
| Operation | Resource | Method | Path |
|---|---|---|---|
| Create a skill category | Skill category | POST | /api/v3/unifiedRouting/skillCategory |
| Create a skill | Skill | POST | /api/v3/unifiedRouting/skill |
| Update a skill | Skill | PUT | /api/v3/unifiedRouting/skill?id={skillId} |
| Fetch a skill by ID | Skill | GET | /api/v3/unifiedRouting/skill?id={skillId} |
| Fetch a skill category by ID | Skill category | GET | /api/v3/unifiedRouting/skillCategory?id={skillCategoryId} |
| Delete a skill | Skill | DELETE | /api/v3/unifiedRouting/skill?id={skillId} |
| Delete a skill category | Skill category | DELETE | /api/v3/unifiedRouting/skillCategory?id={skillCategoryId} |
https://api3.sprinklr.com/{env}/api/v3Replace {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/userAssignmentSettingsInclude the following headers with API requests, as applicable:
| Header | Value | Description |
|---|---|---|
Authorization | Bearer {token} | Authenticates the user with the server. |
Key | {api-key} | Authenticates the application with the server. |
Content-Type | application/json | Identifies the request body format. Required for requests containing a JSON body. |
Accept | application/json | Identifies the acceptable response format. |
POST /api/v3/unifiedRouting/skillCategory
Creates a skill category and optionally associates one or more skills with it.
| Parameter | Sub-parameter | Required | Type | Description |
|---|---|---|---|---|
name | Required | String | Name of the skill category. | |
description | Optional | String | Description of the skill category. | |
skills | Optional | Array<Object> | Skills to associate with the category. | |
skill | Required when a skill object is provided | String | Name of the skill. | |
description | Optional | String | Description of the skill. |
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"
}
]
}'{
"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": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the created skill category details. | |
id | String | Unique identifier of the skill category. | |
name | String | Name of the skill category. | |
description | String | Description of the skill category. | |
skills | Array<Object> | Skills associated with the category. | |
skills | skill | String | Name of the skill. |
description | String | Description of the skill. | |
skillCategory | String | Identifier of the associated skill category. | |
createdTime | Epoch | Time at which the skill was created. | |
modifiedTime | Epoch | Time at which the skill was last modified. | |
data | shareConfigs | Array | Sharing configurations associated with the category. |
errors | Array | Errors encountered during request processing, if any. |
POST /api/v3/unifiedRouting/skill
Creates a skill and associates it with an existing skill category.
| Parameter | Required | Type | Description |
|---|---|---|---|
skill | Required | String | Name of the skill. |
description | Optional | String | Description of the skill. |
skillCategory | Required | String | Unique identifier of the category to which the skill belongs. |
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}"
}'{
"data": {
"id": "6a8c01bfbdcf2ff916a1d60f",
"skill": "Voice Escalation",
"description": "Skill used for handling escalated voice interactions",
"skillCategory": "6a8c0175bdcf2ff916a1ca92",
"createdTime": 1787560383360,
"modifiedTime": 1787560383360
},
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Object | Contains the created skill details. | |
id | String | Unique identifier of the skill. | |
skill | String | Name of the skill. | |
description | String | Description of the skill. | |
skillCategory | String | Identifier of the associated skill category. | |
createdTime | Epoch | Time at which the skill was created. | |
modifiedTime | Epoch | Time at which the skill was last modified. | |
errors | Array | Errors encountered during request processing, if any. |
PUT /api/v3/unifiedRouting/skill?id={skillId}
Updates an existing assignment skill.
| Parameter | Required | Type | Description |
|---|---|---|---|
id | Required | String | Unique identifier of the skill to update. |
| Parameter | Required | Type | Description |
|---|---|---|---|
skill | Required | String | Updated name of the skill. |
description | Optional | String | Updated description of the skill. |
skillCategory | Optional | String | Identifier of the skill category associated with the skill. |
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}"
}'HTTP/1.1 204 No ContentA successful request returns 204 No Content and does not include a response body.
GET /api/v3/unifiedRouting/skill?id={skillId}
Fetches a skill by its unique identifier.
| Parameter | Required | Type | Description |
|---|---|---|---|
id | Required | String | Unique identifier of the skill to fetch. |
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'{
"data": [
{
"id": "6a8c01bfbdcf2ff916a1d60f",
"skill": "Updated Voice Escalation",
"description": "Updated skill for handling escalated voice interactions",
"skillCategory": "6a8c0175bdcf2ff916a1ca92",
"createdTime": 1787560383360,
"modifiedTime": 1787568144241
}
],
"errors": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Array<Object> | Contains the skill details returned by the API. | |
id | String | Unique identifier of the skill. | |
skill | String | Name of the skill. | |
description | String | Description of the skill. | |
skillCategory | String | Identifier of the associated skill category. | |
createdTime | Epoch | Time at which the skill was created. | |
modifiedTime | Epoch | Time at which the skill was last modified. | |
errors | Array | Errors encountered during request processing, if any. |
GET /api/v3/unifiedRouting/skillCategory?id={skillCategoryId}
Fetches a skill category and all skills associated with it.
| Parameter | Required | Type | Description |
|---|---|---|---|
id | Required | String | Unique identifier of the skill category to fetch. |
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'{
"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": []
}| Parameter | Sub-parameter | Type | Description |
|---|---|---|---|
data | Array<Object> | Contains the skill category details. | |
id | String | Unique identifier of the skill category. | |
name | String | Name of the skill category. | |
description | String | Description of the skill category. | |
skills | Array<Object> | Skills associated with the category. | |
skills | id | String | Unique identifier of the skill. |
skill | String | Name of the skill. | |
description | String | Description of the skill. | |
skillCategory | String | Identifier of the associated skill category. | |
createdTime | Epoch | Time at which the skill was created. | |
modifiedTime | Epoch | Time at which the skill was last modified. | |
data | shareConfigs | Array | Sharing configurations associated with the category. |
errors | Array | Errors encountered during request processing, if any. |
DELETE /api/v3/unifiedRouting/skill?id={skillId}
Deletes an existing assignment skill.
| Parameter | Required | Type | Description |
|---|---|---|---|
id | Required | String | Unique identifier of the skill to delete. |
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'HTTP/1.1 204 No ContentA successful request returns 204 No Content and does not include a response body.
DELETE /api/v3/unifiedRouting/skillCategory?id={skillCategoryId}
Deletes an existing assignment skill category.
| Parameter | Required | Type | Description |
|---|---|---|---|
id | Required | String | Unique identifier of the skill category to delete. |
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'HTTP/1.1 200 OKA 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:
- Create a skill category.
- Create one or more skills and associate them with the category.
- Update a skill when its name, description, or category association changes.
- Fetch a skill or skill category to retrieve and verify its current configuration.
- Delete skills that are no longer required.
- Delete a skill category after its associated skills are no longer required.
| Operation | Success status | Response body |
|---|---|---|
| Create skill category | Response object returned | Yes |
| Create skill | Response object returned | Yes |
| Update skill | 204 No Content | No |
| Fetch skill | Response object returned | Yes |
| Fetch skill category | Response object returned | Yes |
| Delete skill | 204 No Content | No |
| Delete skill category | 200 OK | No |
| Task | Call |
|---|---|
| Create a skill category | POST /unifiedRouting/skillCategory with name |
| Create a category and its skills together | POST /unifiedRouting/skillCategory with a populated skills array |
| Add one skill to an existing category | POST /unifiedRouting/skill with skillCategory set |
| Look up a skill's id from its name | GET /unifiedRouting/skill?name=Refunds then read data[0].id |
| List every skill in a category | GET /unifiedRouting/skillCategory?id={id} then read data[0].skills |
| Rename a skill | PUT /unifiedRouting/skill?id={id} with the full skill object |
| Move a skill to another category | PUT /unifiedRouting/skill?id={id} with a new skillCategory |
| Delete one skill | DELETE /unifiedRouting/skill?id={id} |
| Delete a category and all its skills | DELETE /unifiedRouting/skillCategory?id={id} |
| Read an agent's skills and capacity | GET /userAssignmentConfig?userId={userId} then read data[0] |
| Grant an agent a skill | PATCH /userAssignmentConfig?userId={userId} with proficiencies.skillVsProficiency |
| Revoke an agent's skill | PATCH /userAssignmentConfig?userId={userId} with skillsToRemove |
| Reset an agent's whole configuration | PUT /userAssignmentConfig?userId={userId} |
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.
API 3.0 drops kebab-case from path segments entirely. Changing only the version number in your URLs will return 404.
| Resource | API 2.0 | API 3.0 |
|---|---|---|
| Routing root | unified-routing | unifiedRouting |
| Skill category | skill-category | skillCategory |
| Agent configuration | user-settings/assignment-config | userAssignmentConfig |