Send Dunning Email Action

Run an orchestration that sends dunning process emails for collection plans to recover overdue revenue and notify customers about amounts still due.

Specify the collection plan for the dunning emails. Optionally, specify the email template by name or by ID. The action triggers an orchestration that sends dunning process emails for a collection plan based on your configured timeline.

This action is available in API version 67.0 and later.

Special Access Rules

The Send Dunning Email action is available in Enterprise, Unlimited, and Developer Editions of Revenue Cloud.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/blngSendDunningEmail

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a placeholder for your OAuth access token.

Inputs

Input	Type	Description
`collectionPlanId`	string	Required. ID of the collection plan record for dunning emails.
`emailTemplateNameOrId`	string	Email template name or ID to use for the reminder email. If not specified, the default email template is used.

Outputs

Output	Type	Description
`isDunningEmailSent`	boolean	Indicates whether the dunning email related to the collection plan was sent (`true`) or not (`false`).
`additionalInformation`	string	Additional information to be passed on with the response.

Example

POST

This sample request is for the Send Dunning Email action.

1{
2  "inputs": [
3    {
4      "collectionPlanId": "0PLxxxxxxxxxxxxxxx",
5      "emailTemplateNameOrId": "Dunning_Reminder_Template"
6    }
7  ]
8}

This sample response is for the Send Dunning Email action.

1[
2  {
3    "actionName": "blngSendDunningEmail",
4    "errors": null,
5    "invocationId": null,
6    "isSuccess": true,
7    "outcome": null,
8    "outputValues": {
9      "isDunningEmailSent": true,
10      "additionalInformation": null
11    },
12    "sortOrder": -1,
13    "version": 1
14  }
15]