If you are participating in the Zendesk messaging beta, some Chat APIs are not supported. See How Zendesk messaging impacts Chat APIs for more information.
You can use the API to get or set skill information.
Skills are represented as JSON objects with the following properties:
Name |
Type |
Read-only |
Mandatory |
Description |
description |
string |
false |
false |
The description of the skill |
enabled |
integer |
false |
false |
Describes whether the skill is enabled |
id |
integer |
true |
false |
The ID of the skill |
members |
array |
false |
false |
The member agent IDs for the account |
name |
string |
false |
false |
The name of the skill |
Example
{
"description": "English language",
"enabled": 1,
"id": 1,
"members": [
1,
2,
3
],
"name": "english"
}
List Skills
Lists all the skills for your account.
Allowed for
Using curl
curl https://www.zopim.com/api/v2/skills \
-v -u {email_address}:{password}
Example Response
Status 200 OK
[
{
"description": "English language",
"enabled": 1,
"id": 1,
"members": [
1,
2,
3
],
"name": "english"
},
{
"description": "Spanish language",
"enabled": 0,
"id": 2,
"members": [
4,
5,
6
],
"name": "spanish"
}
]
Show Skill
GET /api/v2/skills/{skill_id}
Allowed for
Parameters
Name |
Type |
In |
Required |
Description |
skill_id |
integer |
Path |
true |
The ID of the skill |
Using curl
curl https://www.zopim.com/api/v2/skills/(skill_id) \
-v -u {email_address}:{password}
Example Response
Status 200 OK
{
"description": "English language",
"enabled": 1,
"id": 1,
"members": [
1,
2,
3
],
"name": "english"
}
Show Skill by Name
GET /api/v2/skills/name/{skill_name}
Allowed for
Parameters
Name |
Type |
In |
Required |
Description |
skill_name |
string |
Path |
true |
The name of the skill |
Using curl
curl https://www.zopim.com/api/v2/skills/name/{name} \
-v -u {email_address}:{password}
Example Response
Status 200 OK
{
"description": "English language",
"enabled": 1,
"id": 1,
"members": [
1,
2,
3
],
"name": "english"
}
Create Skill
Allowed for
Using curl
curl https://www.zopim.com/api/v2/skills \
-d '{
"name" : "mandarin",
"description" : "Chinese language",
"enabled" : 1,
"members" : [1, 2, 3]
}' \
-v -u {email_address}:{password} \
-X POST -H "Content-Type: application/json"
Example Response
Status 201 Created
{
"description": "Chinese language",
"enabled": 1,
"id": 4,
"members": [
1,
2,
3
],
"name": "mandarin"
}
Update Skill
PUT /api/v2/skills/{skill_id}
Allowed for
Parameters
Name |
Type |
In |
Required |
Description |
skill_id |
integer |
Path |
true |
The ID of the skill |
Using curl
curl https://www.zopim.com/api/v2/skills/{skill_id} \
-d '{"name": "cantonese"}' \
-v -u {email_address}:{password}
-X PUT -H "Content-Type: application/json"
Example Response
Status 200 OK
{
"description": "Chinese language",
"enabled": 1,
"id": 4,
"members": [
1,
2,
3
],
"name": "cantonese"
}
Update Skill by Name
PUT /api/v2/skills/name/{skill_name}
Allowed for
Parameters
Name |
Type |
In |
Required |
Description |
skill_name |
string |
Path |
true |
The name of the skill |
Using curl
curl https://www.zopim.com/api/v2/skills/name/{name} \
-d '{"name": "cantonese"}' \
-v -u {email_address}:{password}
-X PUT -H "Content-Type: application/json"
Example Response
Status 200 OK
{
"description": "Chinese language",
"enabled": 1,
"id": 4,
"members": [
1,
2,
3
],
"name": "cantonese"
}
Delete Skill
DELETE /api/v2/skills/{skill_id}
Allowed for
Parameters
Name |
Type |
In |
Required |
Description |
skill_id |
integer |
Path |
true |
The ID of the skill |
Using curl
curl https://www.zopim.com/api/v2/skills/{skill_id} \
-v -u {email_address}:{password} -X DELETE
Example Response
Delete Skill by Name
DELETE /api/v2/skills/name/{skill_name}
Allowed for
Parameters
Name |
Type |
In |
Required |
Description |
skill_name |
string |
Path |
true |
The name of the skill |
Using curl
curl https://www.zopim.com/api/v2/skills/name/{name} \
-v -u {email_address}:{password} -X DELETE
Example Response