Send Invoice HTML Report by SID to Email Addresses
This request sends this particular invoice in the HTML format to the email addresses specified in the request.
post | /billing/invoices/{invoice_sid}.html/emails |
Sample
A sample POST request to send an invoice, targeted by secure ID, in the HTML format to the email addresses specified in the request:
curl -X POST \
'https://api.carrierx.com/core/v2/billing/invoices/6765ca8a-91c7-4241-98c6-42803de77e74.html/emails' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-binary 'emails=john.doe%40mail.com' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'
Response
204
status code and the invoice is sent in the HTML format to an email address.
Required Scopes
To send an invoice in the HTML format to an email address the partner must have one of the following scopes enabled:
invoices.manage
invoices.read
Path Arguments
Parameter | Data Type | Description |
---|---|---|
invoice_sid required | string | The invoice secure ID. |
Body Arguments
The body contains the list of the email addresses in the URL-encoded format this invoice must be sent to. If several email addresses are passed, they must be separated with commas also in the URL-encoded format.
In the URL encoded addresses, the @
character is replaced with the %40
sequence of characters, the commas are replaced with %2C
, etc.