Users API (beta)

The Users API may be useful if you need to automatically adjust an agent's limits based on workload or time of day. 

Authentication

For instructions on authenticating, please see Playlist API authentication and security.

Endpoints

All endpoints start with https://api.myplaylist.io. For example, the full URL for GET /zendesk/users would be...

https://api.myplaylist.io/zendesk/users

• List Users
• Update Many Users

List Users

GET /zendesk/users

• Returns active users with access to Playlist Routing.
• Returns up to 3000 rows. 
• Pagination is currently not available.
• Page size and pagination implementations are subject to change.

Example response

{
  "users": [
    {
      "id": 361576231073,
      "inbox_limit": 3,
      "daily_limit": 150,
      "schedule_id": 1500000025882,
      "idle_timeout_enabled": true,
      "idle_timeout": null,
      "idle_status": "away",
      "manager_id": null
    },
    {
      "id": 364058107113,
      "inbox_limit": null,
      "daily_limit": null,
      "schedule_id": 1500000027761,
      "idle_timeout_enabled": false,
      "idle_timeout": null,
      "idle_status": null,
      "manager_id": 361576231073
    }
  ]
}

Update Many Users

PUT /zendesk/users?ids=1,2,3

Bulk update users. Specify up to 100 user IDs with the ids query string parameter. 

Parameters

Example request body

{
  "user": {
    "inbox_limit": 3,
    "daily_limit": 150,
    "idle_timeout_enabled": true,
    "idle_timeout": 30
  }
}