Agent States API v2

This page will help you get started with Agent States API v2.

The Agent States API makes it possible to retrieve a list of defined Agent states and to set states on active Agents externally.

The Retrieve Defined Agent States call provides an array of defined Agent states, including their unique identifiers (UUID), configured for the instance.

Once the UUID for the desired destination state has been retrieved, it can then be applied to an Agent using one of three endpoints identifying the Agent by email, SSO ID, or UUID.

The states are applied to the Agent and reflected in the Response UI except for the Offline state, which logs the Agent out of their current session.