Create an announcement

POST
/api/v2/announcements

Create an announcement

Request

This endpoint expects an object.
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
Allowed values: infowarningcritical

The severity of the announcement

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
Allowed values: infowarningcritical

The severity of the announcement

_statusenum
Allowed values: activeinactivescheduled

The status of the announcement

endTimelongOptional

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

_accessobjectOptional

Errors

Built with