Update a personal notification

Partially updates a personal notification with an application/merge-patch+json body (RFC 7396). Omitted fields stay unchanged; nested objects are deep-merged; nested arrays (for example allocations.ids) are replaced when present. Optional resend fields are cleared with null (for example "settings":{"costAnomalies":{"repeat":null}}). Send null for a settings property to unsubscribe that type. Nulling the last remaining type is 422, decided before the type-permission check, so the status does not depend on which permissions the target user holds. Requires Users Manager (usersManager). For each type still subscribed after the merge, other than costAnomalies, the target user must hold that type's permission, including when the patch does not mention that type (a rename included). The permission id for each type is documented on UserNotificationSettings. A missing permission is 403 with permission and notificationType. A permission lookup that fails is 503. The request also requires the If-Match header and the Idempotency-Key header. With dryRun=true the request goes through the same checks as a real update and returns the notification as it would look after the patch, without changing anything.
Reads are immediately consistent. After a completed update, a GET of that notification returns the new state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

The unique ID of the user. Must belong to the tenant resolved from the bearer token and optional X-Tenant-Id.

string
required
length ≥ 1

The unique ID of the notification config returned by create or list.

Query Params
boolean
Defaults to false

If true, validates the request and returns the would-be result without applying it. The response then carries the X-Dry-Run header.

Body Params

JSON Merge Patch document (RFC 7396). Omitted fields stay unchanged; nested objects are deep-merged; nested arrays are replaced when present. Send null to clear optional members such as repeat.

JSON Merge Patch (RFC 7396) for a personal notification. Omitted fields stay unchanged; nested objects are deep-merged; nested arrays (for example allocations.ids) are replaced when present. Send null to clear optional members such as repeat, whenCostGrows, withinHours, percentIncrease, and minIncrease.

string
length between 1 and 200

Replacement display name when renaming the config.

settings
object

Merge-patch for settings. Omit a property to leave that type unchanged. Send null to unsubscribe that type. After the merge at least one type must remain.

Headers
string
required

The ETag of the current version, from a get, create or update response. A stale value returns 412; re-read the resource and retry with the new ETag.

string
required
length between 1 and 255

Client-generated key (UUID v4 or ULID recommended). Retrying with the same key and request returns the stored response instead of repeating the operation; the key is kept for 24 hours.

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json