Send Notifications
POST/v1/invoices/:id/notify_by/:mediumClick to copy
Use this endpoint to send notifications with the short URL to the customer via email or SMS.
Is this page helpful?
Path Parameters
id *
stringThe unique identifier of the invoice whose link is to be sent by SMS or email.
medium *
stringPossible values:
smsemail
Response Parameters
successbooleanIndicates whether the notifications were sent successfully. Possible values:
true: The notifications were successfully via SMS, email or both.false: The notifications were not sent.
Errors
The API <key/secret> provided is invalid.
Error Status: 4xx
There is a mismatch between the API credentials passed in the API call and those generated on the dashboard.
Solution
The id provided does not exist.
Error Status: 400
The invoice id entered is either invalid or does not belong to the requester account.
Solution
email is not a valid communication medium.
Error Status: 400
There is a spelling error in “email” in the URL.
Solution
Send Notifications
POST/v1/invoices/:id/notify_by/:mediumClick to copy
Use this endpoint to send notifications with the short URL to the customer via email or SMS.
Is this page helpful?
Path Parameters
id *
stringThe unique identifier of the invoice whose link is to be sent by SMS or email.
medium *
stringPossible values:
smsemail
Response Parameters
successbooleanIndicates whether the notifications were sent successfully. Possible values:
true: The notifications were successfully via SMS, email or both.false: The notifications were not sent.
Errors
The API <key/secret> provided is invalid.
Error Status: 4xx
There is a mismatch between the API credentials passed in the API call and those generated on the dashboard.
Solution
The id provided does not exist.
Error Status: 400
The invoice id entered is either invalid or does not belong to the requester account.
Solution
email is not a valid communication medium.
Error Status: 400
There is a spelling error in “email” in the URL.
Solution