API Reference version 2

User in room addon ui update

POST/v2/addon/ui/room/{room_id_or_name}/user/{user_id_or_email}

Push addon ui update to a single user in a room

Path parameters

Type Parameter Description Required?
integer user_id_or_email;

The id or email of the user to push the ui updates

Required
integer room_id_or_name

The id or url encoded name of the room to push the ui updates

Required

Request body

Type Property Description Required?
array glance

Glances to update

An array of the following objects.

Required
object content

The glance contents

Required
obj | obj status

A value of one of the following types.

object [status, object 1]

A lozenge with a label text. See https://docs.atlassian.com/aui/latest/docs/lozenges.html

Required
string type

Valid values: lozenge.

Required
object value

An object with the following properties.

Required
string type

The colour of AUI lozenge to display, these map to the AUI lozenge class names. Please note the value new is deprecated.

Valid values: default, success, error, current, new, complete, moved.

Required
string label

Valid length range: 1 - 20.

Required
object [status, object 2]

The icon for the glance

Required
string type

Valid values: icon.

Required
object value

An object with the following properties.

Required
string url

An URL to the icon

Required
string url@2x

An URL to the high resolution icon

Required
object metadata

Glance metadata for conditions

object label

Free form html label

Required
string type

Valid values: html.

Required
string value

Valid length range: 1 - 1000.

Required
string key

The unique glance key

Valid length range: 1 - 40.

Required
204 No content