API Reference version 2

Get current flag

GET/v2/flag

Get the current flag to display for a user

Authentication required, with scope view_group.
Accessible by users.
200 application/json
Type Property Description Required?
string body

Body of the notification

Required
string title

Title text to display in bold at the top of the notification

Required
string color

Color to use when displaying the flag

Required
string link_url

URL for the action link or button associated with the notification

Required
string link_text

Text of the actionable link/button

Required
string image_url

URL of an image to display in the flag notification

integer id

The unique ID for the flag being displayed. Used when dismissing.

Required