Rule Object


Properties
idstringRead-onlyformat GUID

Rule ID.


revisionintegerRead-onlyformat int64

Revision number, which increments by 1 each time the rule is updated. To prevent conflicting changes, the existing revision must be used when updating a rule.


createdDatestringRead-onlyformat date-time

Date and time when the rule was created.


updatedDatestringRead-onlyformat date-time

Date and time when the rule was updated.


namespacestringminLength 1maxLength 50

The app and entity which the rule belongs to. For example, comments/{BLOG_APP_ID}.


namestringmaxLength 120

Rule name.


audienceobject

Audience to which the rule applies.


triggerobject

A condition that triggers the rule.

Note: If you need to have several triggers for the same namespace, create separate rules.


exemptionsobject

List of site members or groups to whom the rule doesn't apply.


actionobject

What action should be taken after the rule is triggered.


enabledboolean

Whether the rule is enabled.


extendedFieldsobject

Custom field data for the rule object.

Note: You must configure extended fields using schema plugin extensions in your app's dashboard before you can access the extended fields with API calls.

Was this helpful?
Yes
No