PATCH

Update Tip Settings


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates a tipSettings object.

You can't update the default field.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Manage Bookings
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/tip-settings/v1/tip-settings

Body Params
tipSettingsTipSettingsRequired

Tip settings to update.

Response Object
tipSettingsTipSettings

Updated tip settings.

Update tip settings
Request
cURL
curl -X PATCH \ 'https://www.wixapis.com/tip-settings/v1/tip-settings' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ -d '{ "tipSettings": { "id": "1338729c-7255-48f1-a66e-f6a8e4b6f9f3", "presets": [ { "value": 5, "default": true }, { "value": 10 }, { "value": 15 } ], "tipType": "PERCENTAGE", "allowCustomerTip": true, "allowBusinessTipAtPayment": true, "allowCustomAmount": true, "staffDistributionMethod": "PROPORTIONAL", "default": false, "revision": "1" }, "field_mask": { "paths": [ "allowCustomerTip" ] } }'
Response
JSON
{ "tipSettings": { "id": "1338729c-7255-48f1-a66e-f6a8e4b6f9f3", "tipType": "PERCENTAGE", "presets": [ { "value": 5, "default": true }, { "value": 10, "default": null }, { "value": 15, "default": null } ], "allowCustomerTip": true, "allowBusinessTipAtPayment": true, "allowCustomAmount": true, "staffDistributionMethod": "PROPORTIONAL", "revision": "2", "createdDate": "2024-09-23T08:16:35.039Z", "updatedDate": "2024-09-23T08:16:35.039Z", "default": false, "appId": null, "extendedFields": null } }
Errors
428Failed Precondition

There are 3 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?