put
https://api.zenoti.com//v1/group_invoices//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.
UpdateGroupInvoicePropertiesRequest
| Json property | Data type | Description |
|---|---|---|
| property | UpdateGroupInvoiceProperty (enum) | Specifies which property of the group invoice should be updated. Supported values include updating the group invoice name or notes. |
| value | string | The new value to be assigned to the selected property. |
| updated_by_id | GUID | Unique identifier of the employee who performed the update. This is typically required when the request is made using an API key. |
BaseApiV2Response
| Json property | Data type | Description |
|---|---|---|
| error | APIV2ErrorModel | Contains error details if the API request fails. Returns null when the request succeeds. |
APIV2ErrorModel
| Json property | Data type | Description |
|---|---|---|
| code | string | Error code indicating the type of error returned by the API. |
| message | string | Human-readable description explaining the error. |
UpdateGroupInvoiceProperty (Enum)
| Json property | Data type | Description |
|---|---|---|
| Name | enum (0) | Updates the name of the group invoice. |
| Notes | enum (1) | Updates the notes or comments associated with the group invoice. |