Skip to main content
PATCH
Update an announcement

Authorizations

Authorization
string
header
required

Path Parameters

announcementId
string
required

Body

application/json

Update announcement request body

op
string
required

The type of operation to perform

Example:

"replace"

path
string
required

A JSON Pointer string specifying the part of the document to operate on

Example:

"/exampleField"

value
any

A JSON value used in "add", "replace", and "test" operations

Example:

"new example value"

Response

Updated 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
Example:
endTime
integer<int64>

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

Example:

1731439880

_access
object
Example: