Announcements

Update an announcement

PATCH
/api/v2/announcements/{announcementId}

Update an announcement

Authorization

ApiKey read, write
Authorization<token>

In: header

Scope: read, write

Path Parameters

announcementId*string

Request Body

application/json

Update announcement request body

[index: integer]?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/api/v2/announcements/1234567890" \  -H "Content-Type: application/json" \  -d '[    {      "op": "replace",      "path": "/exampleField",      "value": "new example value"    }  ]'
{  "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"}