Skip to content
/
Sends an invoice notifica...

Sends an invoice notification by email

Request

POST {{baseURL}}/pay-int-api/invoices/{{invoiceId}}/send-email-notification

This endpoint sends an invoice notification by email.

See Also:
To retrieve an invoice by ID, see GET /pay-int-api/invoices/{invoiceId}.
To send an invoice notification by SMS, see POST /pay-int-api/invoices/{invoiceId}/send-published-sms-notification.
To download an invoice, see GET /pay-int-api/invoices/{invoiceId}/download-pdf.

Security
Bearer
Path
invoiceIdstring, (uuid)required

Specifies the identifier of the invoice for which to send the notification.

Example:9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70
Headers
x-api-versionstring

Specifies the API version to use for the request.

Example: 1.0

Example:1.0
Bodyapplication/json

The request containing the details for the Email notification.

receiverEmailstring or null

Specifies the email address to send the invoice notification to.

Example: peppared@example.com

Example:"peppared@example.com"
customerConsentboolean

Identifies the customer has consented to receiving the SMS.

If true, the customer has consented to receiving the SMS.
If false, the customer has not consented to receiving the SMS.

Example: true

Example:true
curl -i -X POST \
  https://developer.flute.com/_mock/api-reference/pay-int-api/invoices/9be2f3a4-5b6c-4d7e-8f9a-0b1c2d3e4f70/send-email-notification \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-version: 1.0' \
  -d '{
    "receiverEmail": "peppared@example.com",
    "customerConsent": true
  }'

Responses

Email notification sent successfully.

Response
No content