Sends an invoice notification by SMS

Request

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

This endpoint sends an invoice notification by SMS.

See Also:
To retrieve an invoice by ID, see GET /pay-int-api/invoices/{invoiceId}.
To send an invoice notification by email, see POST /pay-int-api/invoices/{invoiceId}/send-email-notification.
To publish an invoice, see POST /pay-int-api/invoices/publish.

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 SMS notification.

phoneNumberstring or null, (E.164), <= 20 characters^(null|\+\d{1,20})$

Indicates the SMS phone number.

Example: +14155552309

Example:"+14155552309"

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-published-sms-notification \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-version: 1.0' \
  -d '{
    "phoneNumber": "+14155552309",
    "customerConsent": true
  }'

Responses

SMS notification sent successfully.

Response

No content