Products
Update Product
Update an existing Product record.
PUT
Updates an existing Product record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the Product-Edit role.Enums
eProductType — SystemProductType values
eProductType — SystemProductType values
| Value | Name |
|---|---|
| 0 | None |
| 1 | DayPass |
| 2 | CreditBundle |
| 3 | Stationery |
| 4 | BookingFeature |
| 5 | BookingProducts |
| 99 | Other |
eRecurrentProductOptions — AvailableAs values
eRecurrentProductOptions — AvailableAs values
| Value | Name |
|---|---|
| 0 | None |
| 1 | RecurrentOrOneOff |
| 2 | OnlyRecurrent |
| 3 | OnlyOneOff |
Request Body
Required Fields
The Id of the Product record to update.
Business Id.
Product name.
Product description.
Display order.
Product price.
Currency Id.
Optional Fields
Category of the product: DayPass, CreditBundle, Stationery, BookingFeature, BookingProducts, or Other. See
eProductType enum above.Custom text shown on the invoice line instead of the product name.
SKU code.
Tags.
Whether the product is visible to customers on the members portal and mobile app.
Sync to Square.
Tax Rate Id.
Reduced Tax Rate Id.
Exempt Tax Rate Id.
Financial Account Id.
Controls whether the product can be sold as a one-off purchase, a recurring charge, or both (RecurrentOrOneOff, OnlyRecurrent, OnlyOneOff). See
eRecurrentProductOptions enum above.Restrict purchase to contacts (customers without an active contract).
Restrict purchase to customers with an active contract (members).
Tariffs.
Added Tariffs.
Removed Tariffs.
Whether the product is archived. Archived products cannot be sold but existing charges remain active.
Mark the product as featured or highlighted.
Enable stock tracking for this product. When enabled, each sale reduces the stock count.
Allow sales to continue even when stock reaches zero.
Stock level at which a low-stock alert is triggered.
Whether to pro-rate the price when the product is added or removed part-way through a billing period.
New Image Url.
Clear Image File.
Whether to invoice the customer directly rather than their company or team.
Sync to NexKiosk.
Automatically create a delivery record for the customer when this product is purchased.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the product was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response