Send a group invoice email

POST https://api.zenoti.com/v1/group_invoices/{group_invoice_id}/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.

Before you begin

Permission: Manage API Keys (on the Administrator security object) — Required to access Zenoti APIs.

Endpoint

POST /v1/group_invoices/{group_invoice_id}/email

Base URL: https://api.zenoti.com

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Path parameters

Parameter Type Required Description
group_invoice_id string Yes Mandatory Unique 32-character identifier of the group invoice for which you want to send an email.

Response

Success (201 Created)

{
  "is_invoice_created": true,
  "group_invoice": {
    "Id": "de1ae851-008b-4c89-8be4-a785ad946a06",
    "name": "sample string 2",
    "host_id": "b76a8ead-cdb3-47e0-9f43-ff1a54224cad",
    "payment_made_by": "7a37467a-6cb6-4d51-bae0-ebf68f86a927",
    "Invoices": [
      {
        "...": "..."
      }
    ],
    "Redemptions": [
      {
        "...": "..."
      }
    ],
    "Payments": [
      {
        "...": "..."
      }
    ],
    "Price": {
      "...": "..."
    },
    "GroupRedemptions": [
      {
        "...": "..."
      }
    ],
    "GroupPayments": [
      {
        "...": "..."
      }
    ]
  },
  "error": {}
}

Response fields

Field Type Description
is_invoice_created boolean
group_invoice object
group_invoice.Id string
group_invoice.name string
group_invoice.host_id string
group_invoice.payment_made_by string
group_invoice.Invoices object[]
group_invoice.Redemptions object[]
group_invoice.Payments object[]
group_invoice.Price object
group_invoice.GroupRedemptions object[]
group_invoice.GroupPayments object[]
error object

Example

curl --request POST \
  --url 'https://api.zenoti.com/v1/group_invoices/{group_invoice_id}/email' \
  --header 'Authorization: bearer {{access_token}}'
const response = await fetch('https://api.zenoti.com/v1/group_invoices/{group_invoice_id}/email', {
  method: 'POST',
  headers: {
    'Authorization': 'bearer {{access_token}}'
  },
});
const data = await response.json();
import requests

response = requests.post(
    'https://api.zenoti.com/v1/group_invoices/{group_invoice_id}/email',
    headers={
        'Authorization': 'bearer {{access_token}}',
    },
)
data = response.json()
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "bearer {{access_token}}");
var response = await client.PostAsync(
    "https://api.zenoti.com/v1/group_invoices/{group_invoice_id}/email");
var data = await response.Content.ReadAsStringAsync();
require 'net/http'
require 'json'

uri = URI('https://api.zenoti.com/v1/group_invoices/{group_invoice_id}/email')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'bearer {{access_token}}'
response = http.request(request)
data = JSON.parse(response.body)

Error codes

Status Description
400 400
401 Unauthorized -- invalid or expired access token
429 Too many requests -- rate limit exceeded