NUnullplatform
Announcements

Update a notification

Changed on

Changes the fields you send and keeps the rest. Send at least one field.

Set status to closed to close it for everyone, or to open to reopen it. kind, nrn, key, group_key, and recipients can't change. On a notification nullplatform sent your organization (publisher: nullplatform), only status can change.

patch/communications/notification/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/communications/notification/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The ID of the notification, as returned when it was created or listed.

Request body

status'open' | 'closed'

closed closes it for everyone, and open reopens it.

titlestring

The headline. It can't be empty.

bodystring nullable

The text under the title.

severity'informational' | 'maintenance' | 'degraded' | 'outage'
categorystring

As on create.

audienceobject nullable

Announcements only, as on create.

ctaobject nullable

The button, as on create.

mediaobject nullable

Wording by email or in Slack, as on create.

publish_atstring date-time nullable

When it starts showing. null shows it now.

expires_atstring date-time nullable

When it stops showing. null keeps it until you close it.

Example request

{
  "status": "closed",
  "title": "Maintenance moved to Sunday",
  "publish_at": "2026-11-01T09:00:00Z"
}

Response

The updated notification.

idstring uuid

The ID of the notification.

organization_idinteger

Your organization's ID.

kind'broadcast' | 'personal'
categorystring
severity'informational' | 'maintenance' | 'degraded' | 'outage'
status'open' | 'closed'
nrnstring
titlestring
bodystring nullable
audienceobject nullable
ctaobject nullable
mediaobject nullable
keystring nullable
group_keystring nullable
publisher'nullplatform' | 'organization'

organization for your organization's notifications, and nullplatform for the ones nullplatform sends your organization. Only the status of a nullplatform one can change.

publish_atstring date-time nullable
expires_atstring date-time nullable
closed_atstring date-time nullable
closed_byinteger nullable
created_byinteger

The ID of the user who created it.

created_atstring date-time
updated_atstring date-time

Example response

{
  "id": "6f1c2b9e-3a41-4f0e-9d55-2b7c1e0a9f13",
  "organization_id": 1,
  "kind": "broadcast",
  "category": "platform.maintenance",
  "severity": "maintenance",
  "status": "open",
  "nrn": "organization=1",
  "title": "Scheduled maintenance on Saturday",
  "surfaces": [
    {
      "type": "banner",
      "sections": [
        "development"
      ],
      "dismissible": true
    }
  ],
  "publisher": "organization",
  "created_by": 12345,
  "created_at": "2026-10-27T14:03:11.000Z",
  "updated_at": "2026-10-27T14:03:11.000Z"
}

Changes