Skills

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.

JSON Format

Skills are represented as JSON objects with the following attributes.

Name	Type	Read-only	Description
id	integer	yes	The ID of the skill
name	string	no	The name of the skill
description	string	no	The description of the skill
enabled	integer	no	Describes whether the skill is enabled
members	array	no	The member agent IDs for the account

Get All Skills

GET /api/v2/skills

Lists all the skills for your account.

Allowed for

Owner
Administrator

Using cURL

curl https://www.zopim.com/api/v2/skills \
  -v -u {email_address}:{password}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id" : 1,
    "name" : "english",
    "description" : "English language",
    "enabled" : 1,
    "members" : [1, 2, 3]
  },
  {
    "id" : 2,
    "name" : "spanish",
    "description" : "Spanish language",
    "enabled" : 0,
    "members" : [4, 5, 6]
  }
]

Get Skill by ID

GET /api/v2/skills/{skill_id}

Allowed for

Owner
Administrator

Using cURL

curl https://www.zopim.com/api/v2/skills/{skill_id} \
  -v -u {email_address}:{password}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id" : 1,
  "name" : "english",
  "description" : "English language",
  "enabled" : 1,
  "members" : [1, 2, 3]
}

Get Skill by Name

GET /api/v2/skills/name/{name}

Allowed for

Owner
Administrator

Using cURL

curl https://www.zopim.com/api/v2/skills/name/{name} \
  -v -u {email_address}:{password}

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id" : 1,
  "name" : "english",
  "description" : "English language",
  "enabled" : 1,
  "members" : [1, 2, 3]
}

Create Skill

POST /api/v2/skills

Allowed for

Owner
Administrator

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

HTTP/1.1 201 Created
Content-Type: application/json

{
  "id" : 4,
  "name" : "mandarin",
  "description" : "Chinese language",
  "enabled" : 1,
  "members" : [1, 2, 3]
}

Update Skill by ID

PUT /api/v2/skills/{skill_id}

Allowed for

Owner
Administrator

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id" : 4,
  "name" : "cantonese",
  "description" : "Chinese language",
  "enabled" : 1,
  "members" : [1, 2, 3]
}

Update Skill by Name

PUT /api/v2/skills/name/{name}

Allowed for

Owner
Administrator

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

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id" : 4,
  "name" : "cantonese",
  "description" : "Chinese language",
  "enabled" : 1,
  "members" : [1, 2, 3]
}

Delete Skill by ID

DELETE /api/v2/skills/{skill_id}

Allowed for

Owner
Administrator

Using cURL

curl https://www.zopim.com/api/v2/skills/{skill_id} \
  -v -u {email_address}:{password} -X DELETE

Response

Status: 204 No Content

Delete Skill by Name

DELETE /api/v2/skills/name/{name}

Allowed for

Owner
Administrator

Using cURL

curl https://www.zopim.com/api/v2/skills/name/{name} \
  -v -u {email_address}:{password} -X DELETE

Response

Status: 204 No Content