Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
Mark one notification read or unread
Sets the caller's own read state of one feed item. Another user's read state is never affected. Errors: 404 when the item is not in the caller's feed (unknown, outside the caller's projects, or older than the feed window -- indistinguishable); 401 no session; 422 invalid body. Idempotency/Concurrency: naturally idempotent (the flag is set, not toggled); no Idempotency-Key.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
notificationId*stringThe feed item id (Notification.id).
application/json- body
read*booleanThe item with its new read state.
application/json- response
One in-app notification of the signed-in user -- an alert event or a failed operation.
id*stringStable feed item id (alert_<eventId> / operation_<operationId>).
kind*NotificationKind"alert""operation"occurredAt*stringISO-8601 time of the transition / of the operation's failure.
read*booleanThe caller's own read state of this item.
tenantId*stringsubscriptionId*|The owning project's subscription; null when the caller no longer reaches the project (an operation they started).
projectId*|The owning project; null for a tenant-level operation or a project the caller no longer reaches.
region*|The region of the item's project -- the project's own region (region of the project), else its subscription's defaultRegion -- also when the caller no longer reaches that project (projectId is then null). Null means Global: a subscription-wide budget's alert, a tenant-level operation, or a project that no longer exists. The feed itself is never narrowed to one region.
alert*|Set when kind=alert.
operation*|Set when kind=operation.
curl -X PATCH "https://example.com/notifications/string" \ -H "Content-Type: application/json" \ -d '{ "read": true }'{ "id": "string", "kind": "alert", "occurredAt": "string", "read": true, "tenantId": "string", "subscriptionId": "string", "projectId": "string", "region": "string", "alert": { "eventId": "string", "ruleId": "string", "ruleName": "string", "instanceId": "string", "instanceName": "string", "provider": "string", "status": "FIRING", "fromState": "OK", "toState": "OK", "value": 0, "reason": "string" }, "operation": { "operationId": "string", "state": "SUCCEEDED", "action": "string", "resourceKind": "string", "resourceId": "string", "resourceName": "string", "errorCode": "string", "errorMessage": "string" }}