GIgitlab
broadcast_messages

Create a broadcast message

Creates a broadcast message.

post/api/v4/broadcast_messages

Request

  • Base URL
    https://gitlab.com
  • Auth
    none declared

Request body

messagestring required

Message to display

starts_atstring date-time

Starting time

ends_atstring date-time

Ending time

colorstring

Background color (Deprecated. Use "theme" instead.)

fontstring

Foreground color (Deprecated. Use "theme" instead.)

target_access_levelsinteger[]

Target user roles

target_pathstring

Target path

broadcast_type'banner' | 'notification'

Broadcast type. Defaults to banner

dismissableboolean

Is dismissable

theme'indigo' | 'light-indigo' | 'blue' | 'light-blue' | 'green' | 'light-green' | 'red' | 'light-red' | 'dark' | 'light'

The theme for the message

Response

Create a broadcast message

idinteger required
messagestring required
starts_atstring date-time required
ends_atstring date-time required
colorstring required
fontstring required
target_pathstring required
broadcast_typestring required
themestring required
dismissableboolean required
activeboolean required

Example response

{
  "message": "Example broadcast message",
  "starts_at": "2016-01-04T15:39:55.570Z",
  "ends_at": "2016-01-06T15:39:55.570Z",
  "color": "#E75E40",
  "font": "#FFFFFF",
  "target_access_levels": [
    10,
    30
  ],
  "target_path": "*/welcome",
  "broadcast_type": "banner",
  "theme": "indigo"
}

Changes

No recorded changes to this operation across all 5 revisions of this API.