v3

latestOpenAPI 3.0.02026-07-2759120262.8 KB

PSP Announcements

Create an announcement

Create a new announcement for a Public Status Page

post/psps/{pspId}/announcements

Path parameters

pspIdnumber required

ID of the Public Status Page

Request body

titlestring

Title of the announcement

contentstring

Content of the announcement

status'Offline' | 'Pending' | 'Published' | 'Archived'

Status of the announcement. Possible values: Offline (draft, not visible on status page), Pending (scheduled for publication), Published (currently visible on status page), Archived (historical record, no longer visible)

type'Info' | 'Maintenance' | 'Issue'

Type of the announcement. Possible values: Info (general information), Maintenance (scheduled maintenance notification), Issue (incident or issue notification)

startDatestring date-time

Start date of the announcement (ISO 8601 format)

endDatestring date-time nullable

End date of the announcement (ISO 8601 format)

Example request

{
  "title": "Scheduled Maintenance",
  "content": "We will be performing scheduled maintenance on our servers.",
  "status": "Pending",
  "type": "Maintenance",
  "startDate": "2024-01-15T10:00:00.000Z",
  "endDate": "2024-01-15T14:00:00.000Z"
}

Response

The announcement has been successfully created

idinteger required

pspIdinteger nullable required

userIdinteger nullable required

titlestring nullable required

contentstring nullable required

{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:status","oasType":"schema","type":"unknown","description":"Status of the announcement. Possible values: Offline (draft, not visible on status page), Pending (scheduled for publication), Published (currently visible on status page), Archived (historical record, no longer visible)","nullable":true}

{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:type","oasType":"schema","type":"unknown","description":"Type of the announcement. Possible values: Info (general information), Maintenance (scheduled maintenance notification), Issue (incident or issue notification)","nullable":true}

{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:deliveryStatus","oasType":"schema","type":"unknown","description":"Delivery status of the announcement to subscribers. Possible values: CantSend (cannot be sent to subscribers), InQueue (queued for delivery), Sent (successfully delivered)","nullable":true}

{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:startDate","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:endDate","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:creationDate","oasType":"schema","type":"unknown","nullable":true}

{"stackTrail":"components:schemas:PspAnnouncementResponseDto:properties:submitDate","oasType":"schema","type":"unknown","nullable":true}

sentCountinteger nullable required