Send a group invoice email

This API helps you to send a group invoice email to a guest.

To send a group invoice email, you must specify the appropriate details for the group_invoice_id parameter in the API request.

In the API request body, you must specify the required guest_details and email_type details. After you provide the necessary details, this API sends a group invoice email.

Request Body Parameters

NameTypeDescription
guest_detailsCollection of guid and stringList of guest_id and email details of the guest to whom the group invoice is to be sent:
guest_id - guid - Unique 32-character identifier of the guest.
email - string - Email ID of the guest.
email_typeenumIndicates the type of type of email that is to be sent to the guest: 0 - InvoiceAndReceipt.

Response Details

NameTypeDescription
is_invoice_sentbooleanIf true, it indicates that the API has successfully sent the group invoice email to the guest.
errorobjectObject that contains error message and error code details. For more information, refer to the error Object table.

error Object

codemessage
502Invalid inputs.
4061Can not send this mail as Guests cannot receive email.
Language
Credentials
Header
Click Try It! to start a request and see the response here!