Create an organization notification

Creates an organization-wide notification config. settings names one or more public types. Destinations are emails, slackChannels, and teamsChannels arrays. The response returns those three arrays. A channel that a subscribed 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.
Requires the settings (Manage settings) permission.
The Idempotency-Key header is required. The same key and the same body replay the stored success. A different body 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 create and returns 200 with X-Dry-Run: true and null identity fields (id, createTime, updateTime, etag) without creating anything.
Reads are immediately consistent. After a 201, a GET of that notification returns the created config.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
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

Organization notification to create. Unknown fields are rejected. settings must include at least one notification type. destinations must include emails, slackChannels, and teamsChannels, with at least one non-empty array.

Fields of a new organization notification. Unknown fields are rejected. settings must include at least one notification type. destinations must include emails, slackChannels, and teamsChannels, with at least one non-empty array. A channel that a subscribed 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.

string
required
length between 1 and 200

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

destinations
object
required

Delivery targets for this config. Must include emails, slackChannels, and teamsChannels, with at least one non-empty array.

settings
object
required

Subscribed notification settings, one property per type. A present property subscribes that type;
{} subscribes a type that has no fields. Omitting a property on create leaves that type
unsubscribed. At least one property is required. Unknown properties, including dashboard, report,
and commitment subscriptions, prompt schedules, and conditions, are rejected with 422.

Properties and their Console labels:

  • newInvoices: New invoices
  • newProformaInvoices: New proforma invoices
  • paymentReminders: Due or overdue payments
  • creditUtilization: Credit utilization
  • quotaUtilization: Quota utilization
  • cloudIncidents: Cloud incidents
  • newSkuUsage: New SKUs usage detected
  • dailyDigest: Daily digest, one email per selected allocation rule each day
  • weeklyDigest: Weekly digest, one email per selected allocation rule each week
  • monthlyDigest: Monthly digest
  • expertInsights: Third-party insights (Console item "New insights recommended by DoiT experts")
  • insights: New insights
  • costAnomalies: Cloud cost anomalies (Console item "Cost anomaly detection")
  • savingsPlanApproval: Savings Plan purchase requires approval (PerfectScale for Commitments)
  • savingsPlanPurchased: Savings Plan purchased
  • cudApproval: committed use discount (CUD) purchase requires approval
  • cudPurchased: CUD purchased
  • dataIntegrationSyncFailure: Data integration sync failures
  • awsBillingDataImport: AWS Billing Data Import Alert

Requires Manage settings; no other permission is checked.

Every destination channel must be supported by every subscribed type, or the response is 422
customers.channel_not_supported:

  • Email and Slack only: expertInsights, dataIntegrationSyncFailure
  • Email, Slack, and Microsoft Teams: every other property
  • A Teams destination on a supported type is still 422 validation_failed when the tenant has
    no Teams entitlement
Headers
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