For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inTry it free
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
DocsGuidesSDKsIntegrationsAPI docsTutorialsFlagship blog
  • REST API overview
    • Access Tokens
    • Account Members
    • Account Usage Beta
    • AI Configs
    • Announcements
      • POSTCreate an announcement
      • DELDelete an announcement
      • GETGet announcements
      • PATCHUpdate an announcement
    • Applications Beta
    • Approvals
    • Approvals Beta
    • Audit Log
    • Code References
    • Contexts
    • Context Settings
    • Custom Roles
    • Data Export Destinations
    • Environments
    • Experiments
    • Feature Flags
    • Feature Flags Beta
    • Flag Import Configurations Beta
    • Flag Links Beta
    • Flag Triggers
    • Follow Flags
    • Holdouts Beta
    • Insights Charts Beta
    • Insights Deployments Beta
    • Insights Flag Events Beta
    • Insights Pull Requests Beta
    • Insights Repositories Beta
    • Insights Scores Beta
    • Integration Audit Log Subscriptions
    • Integration Delivery Configurations Beta
    • Integrations Beta
    • Layers
    • Metrics
    • Metrics Beta
    • OAuth2 Clients
    • Persistent Store Integrations Beta
    • Projects
    • Relay Proxy Configurations
    • Release Pipelines Beta
    • Releases Beta
    • Scheduled Changes
    • Segments
    • Tags
    • Teams
    • Teams Beta
    • Users
    • Users Beta
    • User Settings
    • Views Beta
    • Webhooks
    • Workflows
    • Workflow Templates
    • Other
Sign inTry it free
LogoLogo
REST API overviewAnnouncements

Create an announcement

POST
/api/v2/announcements
POST
/api/v2/announcements
$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
>}'
1{
2  "_id": "1234567890",
3  "isDismissible": true,
4  "title": "System Maintenance Notice",
5  "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**.",
6  "startTime": 1731439812,
7  "severity": "info",
8  "_status": "active",
9  "_links": {
10    "parent": {
11      "href": "href",
12      "type": "type"
13    }
14  },
15  "endTime": 1731439880,
16  "_access": {
17    "allowed": [
18      {
19        "action": "action",
20        "reason": {
21          "effect": "allow",
22          "resources": [
23            "proj/*:env/*;qa_*:/flag/*"
24          ],
25          "notResources": [
26            "notResources",
27            "notResources"
28          ],
29          "actions": [
30            "*"
31          ],
32          "notActions": [
33            "string",
34            "string"
35          ],
36          "role_name": "role_name"
37        }
38      },
39      {
40        "action": "action",
41        "reason": {
42          "effect": "allow",
43          "resources": [
44            "proj/*:env/*;qa_*:/flag/*"
45          ],
46          "notResources": [
47            "notResources",
48            "notResources"
49          ],
50          "actions": [
51            "*"
52          ],
53          "notActions": [
54            "string",
55            "string"
56          ],
57          "role_name": "role_name"
58        }
59      }
60    ],
61    "denied": [
62      {
63        "action": "action",
64        "reason": {
65          "effect": "allow",
66          "resources": [
67            "proj/*:env/*;qa_*:/flag/*"
68          ],
69          "notResources": [
70            "notResources",
71            "notResources"
72          ],
73          "actions": [
74            "*"
75          ],
76          "notActions": [
77            "string",
78            "string"
79          ],
80          "role_name": "role_name"
81        }
82      },
83      {
84        "action": "action",
85        "reason": {
86          "effect": "allow",
87          "resources": [
88            "proj/*:env/*;qa_*:/flag/*"
89          ],
90          "notResources": [
91            "notResources",
92            "notResources"
93          ],
94          "actions": [
95            "*"
96          ],
97          "notActions": [
98            "string",
99            "string"
100          ],
101          "role_name": "role_name"
102        }
103      }
104    ]
105  }
106}
Create an announcement
Was this page helpful?
Previous

Delete an announcement

Next
Built with

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