createRule( )

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 createRule() function returns a Promise that resolves to the created rule.

To create multiple rules at once, use the bulkCreateRules() 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
ruleRuleRequired

Rule to create.

Returns
Return Type:Promise<Rule>
Did this help?