Update Group Invoice Properties

PUT https://api.zenoti.com/{base_url}/v1/group_invoices/{group_invoice_id}/properties

This API updates specific properties of a group invoice — either its name or notes — using the group invoice ID. It accepts a property type (0 for name, 1 for notes) and a new value, and optionally an employee ID to record who made the change when the request is made using an API key.

Before you begin

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

Endpoint

PUT /{base_url}/v1/group_invoices/{group_invoice_id}/properties

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

Request

Headers

Header Required Description
Authorization Yes bearer {{access_token}}

Response

Success (200 OK)

{}

Example

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

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

uri = URI('https://api.zenoti.com/{base_url}/v1/group_invoices/{group_invoice_id}/properties')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Put.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