GitLab · JSON Structure

Gitlab Api V4 Broadcast Messages Api_Entities_Broadcast Message Structure

API_Entities_BroadcastMessage model

Type: object Properties: 11
CodePlatformSoftware DevelopmentSource Control

API_Entities_BroadcastMessage is a JSON Structure definition published by GitLab, describing 11 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id message starts_at ends_at color font target_access_levels target_path broadcast_type dismissable active

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gitlab/refs/heads/main/json-structure/gitlab-api-v4-broadcast-messages-api_entities_broadcast-message-structure.json",
  "name": "API_Entities_BroadcastMessage",
  "description": "API_Entities_BroadcastMessage model",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "123456"
    },
    "message": {
      "type": "string",
      "example": "example_value"
    },
    "starts_at": {
      "type": "string",
      "example": "2026-04-17T12:00:00Z"
    },
    "ends_at": {
      "type": "string",
      "example": "2026-04-17T12:00:00Z"
    },
    "color": {
      "type": "string",
      "example": "example_value"
    },
    "font": {
      "type": "string",
      "example": "example_value"
    },
    "target_access_levels": {
      "type": "string",
      "example": "example_value"
    },
    "target_path": {
      "type": "string",
      "example": "my-group/my-project"
    },
    "broadcast_type": {
      "type": "string",
      "example": "example_value"
    },
    "dismissable": {
      "type": "string",
      "example": "example_value"
    },
    "active": {
      "type": "string",
      "example": "example_value"
    }
  }
}