Update an organization notification

Partially updates an organization 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. When destinations is present it replaces the whole destinations object; the nested emails, slackChannels, and teamsChannels arrays are the full lists. Send null for a settings property to unsubscribe that type. Nulling the last type is 422. A channel that a remaining type does not support is 422 customers.channel_not_supported. A Teams destination on a type that supports Teams is 422 validation_failed when the tenant has no Teams entitlement. Optional resend fields are cleared with null (for example "settings":{"costAnomalies":{"repeat":null}}). minSeverity, minExcessCost, and allocations cannot be cleared. An id whose config stores a dashboard, report, or commitment subscription or a prompt schedule returns 404. A settings property that is not on PatchCustomerNotificationSettings is 422.
Requires the settings (Manage settings) permission and the If-Match header. The Idempotency-Key header is required. The same key, the same body, and the same If-Match replay the stored success. A different body or a different If-Match is 422 idempotency_key_reused. A 5xx response may leave the key reserved, so a retry returns 409 until the original request is released or about 30 minutes pass. dryRun=true does not reserve the key. 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 notification config returned by create or list.
An id that is not a public organization config for this tenant returns 404.

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 an organization notification. Omitted fields stay unchanged; nested objects are deep-merged; nested arrays (for example allocations.ids) are replaced when present. When destinations is present it replaces the whole destinations object. Send null for a settings property to unsubscribe that type. Nulling the last type is 422. Send null to clear optional members such as repeat, whenCostGrows, withinHours, percentIncrease, and minIncrease.

string
length between 1 and 200

Display name of the notification (max 200 characters). The stored name is trimmed.

destinations
object

Replacement destinations when present. Replaces the whole object; all three arrays are required and at least one must be non-empty.

settings
object

Merge-patch for settings. Omit a property to leave that type unchanged. A property you send is merged into the stored settings for that type, not substituted for them: a nested field you omit keeps its stored value, a nested array you send replaces the stored one, and an explicit empty array clears an optional filter. Send null to unsubscribe that type. After the merge at least one type must remain. conditions is rejected with 422. A channel that a remaining type does not support is 422 customers.channel_not_supported. A Teams destination on a type that supports Teams is 422 validation_failed when the tenant has no Teams entitlement.

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