Skip to main content
POST
/
api
/
v2
/
announcements
Create an announcement
curl --request POST \
  --url https://app.launchdarkly.com/api/v2/announcements \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "severity": "warning",
  "startTime": 1731439812,
  "isDismissible": true,
  "endTime": 1731439880,
  "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**."
}
'
{
  "severity": "info",
  "_access": {
    "allowed": [
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      },
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      }
    ],
    "denied": [
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      },
      {
        "reason": {
          "role_name": "role_name",
          "notActions": [
            null,
            null
          ],
          "notResources": [
            "notResources",
            "notResources"
          ],
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "actions": [
            "*"
          ]
        },
        "action": "action"
      }
    ]
  },
  "_links": {
    "parent": {
      "href": "href",
      "type": "type"
    }
  },
  "startTime": 1731439812,
  "_id": "1234567890",
  "isDismissible": true,
  "endTime": 1731439880,
  "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**.",
  "_status": "active"
}

Documentation Index

Fetch the complete documentation index at: https://launchdarkly-preview.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Body

application/json

Announcement request body

Create announcement request body

​
isDismissible
boolean
required

true if the announcement is dismissible

Example:

true

​
title
string
required

The title of the announcement

Example:

"System Maintenance Notice"

​
message
string
required

The message of the announcement

Example:

"**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
integer<int64>
required

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

Example:

1731439812

​
severity
enum<string>
required

The severity of the announcement

Available options:
info,
warning,
critical
Example:

"warning"

​
endTime
integer<int64>

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

Example:

1731439880

Response

Created announcement

Announcement response

​
_id
string
required

The ID of the announcement

Example:

"1234567890"

​
isDismissible
boolean
required

true if the announcement is dismissible

Example:

true

​
title
string
required

The title of the announcement

Example:

"System Maintenance Notice"

​
message
string
required

The message of the announcement

Example:

"**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
integer<int64>
required

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

Example:

1731439812

​
severity
enum<string>
required

The severity of the announcement

Available options:
info,
warning,
critical
​
_status
enum<string>
required

The status of the announcement

Available options:
active,
inactive,
scheduled
​
_links
object
required
Example:
{
  "parent": { "href": "href", "type": "type" }
}
​
endTime
integer<int64>

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

Example:

1731439880

​
_access
object
Example:
{
  "allowed": [
    {
      "reason": {
        "role_name": "role_name",
        "notActions": [null, null],
        "notResources": ["notResources", "notResources"],
        "effect": "allow",
        "resources": ["proj/*:env/*;qa_*:/flag/*"],
        "actions": ["*"]
      },
      "action": "action"
    },
    {
      "reason": {
        "role_name": "role_name",
        "notActions": [null, null],
        "notResources": ["notResources", "notResources"],
        "effect": "allow",
        "resources": ["proj/*:env/*;qa_*:/flag/*"],
        "actions": ["*"]
      },
      "action": "action"
    }
  ],
  "denied": [
    {
      "reason": {
        "role_name": "role_name",
        "notActions": [null, null],
        "notResources": ["notResources", "notResources"],
        "effect": "allow",
        "resources": ["proj/*:env/*;qa_*:/flag/*"],
        "actions": ["*"]
      },
      "action": "action"
    },
    {
      "reason": {
        "role_name": "role_name",
        "notActions": [null, null],
        "notResources": ["notResources", "notResources"],
        "effect": "allow",
        "resources": ["proj/*:env/*;qa_*:/flag/*"],
        "actions": ["*"]
      },
      "action": "action"
    }
  ]
}