Send Email Response

Output representation of the API request to send emails for posted invoices.

JSON Example

This example shows a sample response when the request is successful.

1{
2  "errors": [],
3  "requestIdentifier": "5IRLT000001SIJB4A4",
4  "success": true
5}

This example shows a sample response with an error scenario.

1{
2  "errors": [
3    {
4      "errorCode": "INVALID_API_INPUT",
5      "errorMessage": "Specify a valid invoiceBatchRunId."
6    }
7  ],
8  "requestIdentifier": "5IRxx0000004CKKGA2",
9  "success": false
10}

Property Name	Type	Description	Filter Group and Version	Available Version
`errors`	Send Email Error[]	List of errors that occurred while trying to enqueue the request. In case of errors while sending emails, you can check the Revenue Transaction Error Logs of the InvoiceBatchRun record and associated Invoice record. An error occurs for these scenarios. The contact email or user isn’t configured; The configured email template isn’t valid; or Email is sent through a contact email, and the contact doesn’t have an associated user. In this scenario, the emails are counted against the general email limits. An error is thrown if you exceed the email limits.	Big, 65.0	65.0
`requestIdentifier`	String	Unique identifier for the request, which corresponds to the invoice batch run ID.	Big, 65.0	65.0
`success`	Boolean	Indicates whether the request to start the email sending process was successfully enqueued (`true`) or not (`false`).	Big, 65.0	65.0