Create Consumption Alert
Sends a notification to specified users when consumption for a card meets or exceeds a
specified threshold. This object is available in API version 63.0 and later.
Supported REST HTTP Methods
URI: /services/data/v63.0/actions/standard/createConsumptionAlert
Formats: JSON, XML
HTTP Methods: GET, HEAD, POST
Authentication: Authorization: Bearer token
Inputs
| Input | Type | Description |
|---|---|---|
| alertTriggerType | picklist | Required. The type of threshold that triggers the alert: ThresholdPercent or ThresholdUnits. |
| alertTriggerValue | int | Required. The numeric threshold that was crossed to trigger the alert. |
| businessEnvType | picklist | Required. The environment type of the org that triggered the usage: Production or Sandbox. |
| cardDefinitionDeveloperName | string | Required. The developer name for the Digital Wallet consumption card that you're raising an alert for. This name is often different from the display name. See Salesforce Help: Change a Consumption Threshold for a Specific Card for information on how to map the developer name to the card display name. |
| recipientIds | ID (array, max 1000) | Optional. The list of user IDs for the recipients being notified. Required when sendNotification is true. |
| sendNotification | boolean | Optional. If true, notifies recipients when the alert is created. If false, the alert is created without sending notifications. Defaults to true. |
| usageModel | picklist | Required. The buying model for the contract: PrePurchased, PayGo, PreCommitted, or Unlimited. |