POST

Send an invoice by email

Scope: sales:invoices.write https://api.alladdin.com/api/v2/invoices/{invoiceId}/send

Sends the invoice by email to the contact. The email uses the template and sender address configured in your account settings.
You can optionally specify recipient email addresses, subject, and message body. If omitted, the defaults from your email template are used. The contact does not need to have an email address if you provide one in the request.

Parameters

Path parameters

invoiceId string required

Invoice ID (24-char hex ObjectId)

Request body

object emails[] string[] required

List of recipient email addresses

subject string | null optional

Custom email subject line

message string | null optional

Custom email body message

mail_template_id string | null optional

Identifier of the email template to use

cc[] string[] | null optional

List of CC email addresses

bcc[] string[] | null optional

List of BCC email addresses

Request

python

import requests

url = "https://api.alladdin.com/api/v2/invoices/{invoiceId}/send"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

payload = {
    "emails": [
        "string"
    ],
    "subject": "string",
    "message": "string",
    "mail_template_id": "string",
    "cc": [
        "string"
    ],
    "bcc": [
        "string"
    ]
}
response = requests.post(url, headers=headers, json=payload)
print(response.json())

Responses

Success responses

200 Invoice sent

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Invoice not found application/json 429 Rate limit exceeded application/json

← PreviousAttach a file to an invoice →

Next →Update an invoice →

Alladdin