INinvoiceninja
emails

Sends an email for an entity

Changed on

Sends an email for an entity

post/api/v1/emails

Request

Headers

X-Requested-Withstring required
Example:XMLHttpRequest

Used to send the XMLHttpRequest header

Request body

subjectstring

The email subject

bodystring

The email body

entitystring required

The entity name

entity_idstring required

The entity_id

cc_emailstring

The email address of a user to be CC'd on the email

template'email_template_invoice' | 'email_template_quote' | 'email_template_credit' | 'email_template_payment' | 'email_template_payment_partial' | 'email_template_statement' | 'email_template_reminder1' | 'email_template_reminder2' | 'email_template_reminder3' | 'email_template_reminder_endless' | 'email_template_custom1' | 'email_template_custom2' | 'email_template_custom3' | 'email_template_purchase_order' | 'email_quote_template_reminder1' required

The template required

Example request

{
  "template": "email_template_invoice"
}

Response

success

htmlstring

The template HTML

Example response

{
  "html": "<HTML></HTML>"
}

Changes

  • d5c45b441b72Revision changes
    • breaking

      removed the enum value credit of the request property

    • breaking

      removed the enum value custom1 of the request property

    • breaking

      removed the enum value custom2 of the request property

    • breaking

      removed the enum value custom3 of the request property

    • breaking

      removed the enum value invoice of the request property

    • breaking

      removed the enum value payment of the request property

    • breaking

      removed the enum value payment_partial of the request property

    • breaking

      removed the enum value purchase_order of the request property

    • breaking

      removed the enum value quote of the request property

    • breaking

      removed the enum value reminder1 of the request property

    • breaking

      removed the enum value reminder2 of the request property

    • breaking

      removed the enum value reminder3 of the request property

    • breaking

      removed the enum value reminder_endless of the request property

    • breaking

      removed the enum value statement of the request property

    • info

      added the new email_template_credit enum value to the request property

    • info

      added the new email_template_custom1 enum value to the request property

    • info

      added the new email_template_custom2 enum value to the request property

    • info

      added the new email_template_custom3 enum value to the request property

    • info

      added the new email_template_invoice enum value to the request property

    • info

      added the new email_template_payment enum value to the request property

    • info

      added the new email_template_payment_partial enum value to the request property

    • info

      added the new email_template_purchase_order enum value to the request property

    • info

      added the new email_template_quote enum value to the request property

    • info

      added the new email_template_reminder1 enum value to the request property

    • info

      added the new email_template_reminder2 enum value to the request property

    • info

      added the new email_template_reminder3 enum value to the request property

    • info

      added the new email_template_reminder_endless enum value to the request property

    • info

      added the new email_template_statement enum value to the request property

  • a80e474b5da3Revision changes
    • breaking

      request property was restricted to a list of enum values

    • info

      added the new credit enum value to the request property

    • info

      added the new custom1 enum value to the request property

    • info

      added the new custom2 enum value to the request property

    • info

      added the new custom3 enum value to the request property

    • info

      added the new email_quote_template_reminder1 enum value to the request property

    • info

      added the new invoice enum value to the request property

    • info

      added the new payment enum value to the request property

    • info

      added the new payment_partial enum value to the request property

    • info

      added the new purchase_order enum value to the request property

    • info

      added the new quote enum value to the request property

    • info

      added the new reminder1 enum value to the request property

    • info

      added the new reminder2 enum value to the request property

    • info

      added the new reminder3 enum value to the request property

    • info

      added the new reminder_endless enum value to the request property

    • info

      added the new statement enum value to the request property