Custom Unified Status Attributes

Attributes about the custom unified status, part of the Custom Unified Status Attributes JSON response.

JSON format

Custom unified status attributes are represented as JSON objects with the following properties:

Name	Type	Read-only	Mandatory	Description
channels	object	true	true	A mapping of agent statuses for each channel
description	string	true	false	The unified status description
group_ids	array	true	false	The list of group ids eligible to use the custom status. An empty array means eligible for all agents
name	string	true	true	The name displayed to agents in the unified status switcher, unique per account

Attributes about the custom unified status

Example

{
  "channels": {
    "messaging": "away",
    "support": "online",
    "talk": "away"
  },
  "description": "Temporarily unavailable but accepting emails",
  "group_ids": [
    123456,
    234567
  ],
  "name": "In a meeting"
}