Update a broadcast message

PUT

/api/v4/broadcast_messages/{id}

• GitLab REST API

Updates a specified broadcast message.

Authorizations

• http
• oauth2

Parameters

Path Parameters

id

required

integer

Broadcast message ID

Request Body

Media type application/json

object

message

Message to display

string

nullable

starts_at

Starting time

string format: date-time

nullable

ends_at

Ending time

string format: date-time

nullable

color

Background color (Deprecated. Use “theme” instead.)

string

nullable

font

Foreground color (Deprecated. Use “theme” instead.)

string

nullable

target_access_levels

Target user roles

Array<integer>

nullable

target_path

Target path

string

nullable

broadcast_type

Broadcast Type

string

nullable

Allowed values: banner notification

dismissable

Is dismissable

boolean

nullable

theme

The theme for the message

string

nullable

Allowed values: indigo light-indigo blue light-blue green light-green red light-red dark light

Responses

200

OK

Media type application/json

object

id

integer format: int64

message

string

starts_at

string format: date-time

ends_at

string format: date-time

color

string

font

string

target_access_levels

array

target_path

string

broadcast_type

string

theme

string

dismissable

boolean

active

boolean

Example

{
  "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"
}

400

Bad Request

404

Not Found