updateRule( )

Developer Preview

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

The updateRule() function returns a Promise that resolves to the updated rule.

Each time the task is updated, revision increments by 1. The existing revision must be included when updating the task. This ensures you're working with the latest task and prevents unintended overwrites.

To update multiple rules at once, use the bulkUpdateRules() function.

Authentication

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
_idstringRequired

Rule ID.

ruleUpdateRuleRequired
optionsUpdateRuleOptions
Returns
Return Type:Promise<Rule>
Was this helpful?
Yes
No