Update notice

PUT

/notices/{id}

Last modified:2026-10-12 18:08:01

OperationId:UpdateNotice

Updates an existing notice by numeric id. Also served on PATCH. Requires Super User or Reseller scope, and the caller must be allowed to manage both the notice's current target and, if the body changes it, the new target. All body fields are optional; only the fields you send are changed. The update is published on the event bus; the response status is 200 and the body is the prior row merged with your changes. To retire a notice, set active=0 or shorten ends_at rather than deleting it.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

The updated notice.

Bodyapplication/json

🟠400Err400

🟠401Err401

🟠403Err403

🟠404Err404

🔴500Err500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/notices/4821' \
--header 'Content-Type: application/json' \
--data '{
    "active": 0,
    "ends_at": "2026-09-05T03:30:00+00:00"
}'

Response Example

200 - Success Example

{
    "id": 4821,
    "notice_uid": "7c3a2f14-9b5e-4d21-8f6a-1c2d3e4f5a6b",
    "type": "scheduled_maintenance",
    "title": "Planned maintenance on Saturday",
    "message": "The platform will undergo scheduled maintenance on Saturday between 02:00 and 04:00 UTC. Calls may be briefly interrupted.",
    "link_url": "https://status.example.com/incidents/2026-09-05",
    "target_type": "domain",
    "target_value": "acme.example.com",
    "active": 1,
    "created_by": "1001@example.com",
    "starts_at": "2026-09-05T02:00:00Z",
    "ends_at": "2026-09-05T04:00:00Z",
    "created_at": "2026-09-01T14:30:00Z",
    "updated_at": "2026-09-01T14:30:00Z"
}

Modified at 2026-10-12 18:08:01

Get notice

Delete notice