Method: alerts.batchDelete

Performs batch delete operation on alerts.

HTTP request

POST https://alertcenter.googleapis.com/v1beta1/alerts:batchDelete

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "customerId": string,
  "alertId": [
    string
  ]
}
Fields
customerId

string

Optional. The unique identifier of the Google Workspace account of the customer the alerts are associated with. The customerId must have the initial "C" stripped (for example, 046psxkn). Inferred from the caller identity if not provided. Find your customer ID.
alertId[]

string

Required. The list of alert IDs to delete.

Response body

Response to batch delete operation on alerts.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "successAlertIds": [
    string
  ],
  "failedAlertStatus": {
    string: {
      object (google.rpc.Status)
    },
    ...
  }
}
Fields
successAlertIds[]

string

The successful list of alert IDs.
failedAlertStatus

map (key: string, value: object (google.rpc.Status))

The status details for each failed alertId.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/apps.alerts

For more information, see the Authorization guide.