Create an announcement | LaunchDarkly

curl -X POST https://app.launchdarkly.com/api/v2/announcements \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "isDismissible": true,
  "title": "System Maintenance Notice",
  "message": "**Important Update:**\n\nPlease be aware of the upcoming maintenance scheduled for *October 31st, 2024*. The system will be unavailable from **12:00 AM** to **4:00 AM**.",
  "startTime": 1731439812,
  "severity": "warning",
  "endTime": 1731439880
}'

{
  "_id": "1234567890",
  "isDismissible": true,
  "title": "System Maintenance Notice",
  "message": "**Important Update:**\n\nPlease be aware of the upcoming maintenance scheduled for *October 31st, 2024*. The system will be unavailable from **12:00 AM** to **4:00 AM**.",
  "startTime": 1731439812,
  "severity": "info",
  "_status": "active",
  "_links": {
    "parent": {
      "href": "href",
      "type": "type"
    }
  },
  "endTime": 1731439880,
  "_access": {
    "allowed": [
      {
        "action": "action",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string",
            "string"
          ],
          "role_name": "role_name"
        }
      },
      {
        "action": "action",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string",
            "string"
          ],
          "role_name": "role_name"
        }
      }
    ],
    "denied": [
      {
        "action": "action",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string",
            "string"
          ],
          "role_name": "role_name"
        }
      },
      {
        "action": "action",
        "reason": {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string",
            "string"
          ],
          "role_name": "role_name"
        }
      }
    ]
  }
}

Create an announcement

Authentication

Authorizationstring

API Key authentication via header

Request

Announcement request body

isDismissiblebooleanRequired

true if the announcement is dismissible

titlestringRequired

The title of the announcement

messagestringRequired

The message of the announcement

startTimelongRequired

The start time of the announcement. This is a Unix timestamp in milliseconds.

severityenumRequired

The severity of the announcement

Allowed values:

endTimelongOptional

The end time of the announcement. This is a Unix timestamp in milliseconds.

Response

Created announcement

_idstring

The ID of the announcement

isDismissibleboolean

true if the announcement is dismissible

titlestring

The title of the announcement

messagestring

The message of the announcement

startTimelong

The start time of the announcement. This is a Unix timestamp in milliseconds.

severityenum

The severity of the announcement

Allowed values:

_statusenum

The status of the announcement

Allowed values:

_linksobject

endTimelong

The end time of the announcement. This is a Unix timestamp in milliseconds.

_accessobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error