Unified Agent Status API
The Zendesk Unified Agent Status APIs allow admins to query all existing unified statuses for the account, and also update the unified status for agents.
A unified agent status represents an agent's availability for each channel of work. As such it includes statuses (such as online) for each channel (such as messaging) and the unified status id.
Available unified statuses include default unified statuses that are provided by Zendesk, as well as custom unified statuses created by your account admins.
The following are default unified statuses provided by Zendesk which you can use without any additional configuration.
| Name | Description | Channel Mapping | Id |
|---|---|---|---|
| Offline | Can't receive work | All channels offline | 2 |
| Online | Can receive work | All channels online | 3 |
| Away | Can only receive email tickets | All channels offline | 4 |
| Transfers Only | Can only receive work from other agents | All channels transfers only | 5 |
You can use the Unified Agent Status APIs to enhance or develop monitoring, reporting, or routing functionality.
Run in Postman
If you use Postman, you can import the Unified Agent Status API endpoints as a collection into your Postman app, then try out different requests to learn how the API works. Click the following button to get started:
If you don't use Postman, you can sign up for a free account on the Postman website and download the app. For more information about using Postman with Zendesk APIs, see Exploring Zendesk APIs with Postman.
Response format
This API is based on the JSON:API specification, and this documentation assumes that you are familiar with that specification. It supports cursor pagination, and does not support offset pagination.