TODO Auto Rules
A TODO auto rule creates and completes TODOs automatically in response to system events. See Auto Rules for how they work.
Methods
Section titled “Methods”Retrieve Single TODO Auto Rule
Section titled “Retrieve Single TODO Auto Rule”/backend/api/v1/todoAutoRules/ID - fetch the auto rule with the specified ID.
List TODO Auto Rules
Section titled “List TODO Auto Rules”/backend/api/v1/todoAutoRules/ - list all auto rules.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include rules with a higher ID |
createdSince | datetime | No | Only include rules created since the given time |
updatedSince | datetime | No | Only include rules updated since the given time |
/backend/api/v1/todoAutoRules/ - add a new auto rule. The newly-added rule will be returned.
/backend/api/v1/todoAutoRules/ID - update the auto rule with the specified ID. The modified rule will be returned.
DELETE
Section titled “DELETE”/backend/api/v1/todoAutoRules/ID - delete the auto rule with the specified ID.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| enabled | Enabled | Text | Turn this auto rule on or off. |
| name | Name | Text | Short, unique name for this rule. |
| description | Description | Text (Multiline) | Optional description to clarify the purpose of this rule. |
| todoType | TODO Type | Preset Value | Type to assign to created TODOs. Used for permissions and context. |
| repeatRule | Repeat Rule (optional) | Preset Value | Optional recurrence preset to apply to created TODOs. |
| closeOnCustomerDrop | Close When Customer Dropped | Text | When enabled, TODOs created under this rule are auto-completed (or sent for review) when the linked customer is dropped, based on customerID, regardless of the attached object. |
| reviewRequired | Review Required | Text | If enabled, completion moves TODOs into the review stage first. |
| reviewUsers | Reviewers (Users) | Preset Value(s) | Default reviewers (users) for created TODOs. |
| reviewDepartments | Reviewers (Departments) | Preset Value(s) | Default reviewers (departments) for created TODOs. |
| createEventIDs | Create Events | Text | System events that create a TODO under this rule. |
| completeEventIDs | Complete Events | Text | System events that auto-complete or send for review matching TODOs. |
| createActivityTypeIDs | Trigger on Activity Types | Preset Value(s) | Optional. User activity types that should create TODOs when logged against matching objects. Leave blank to ignore user activity triggers for this rule. |
| completeActivityTypeIDs | Complete on Activity Types | Preset Value(s) | Optional. User activity types that should complete or send for review matching TODOs when logged against matching objects. Leave blank to ignore activity-based completion for this rule. |
| activityOnObjectTypes | Activity On Object Types | Text | Optional. Restrict activity-based triggers to specific object types (matching Activity On Type in the user activity log). Leave blank for any. |
| notBeforeDays | Snooze (working days) | Text | Number of working days to delay visibility (sets notBeforeDate). 0 means no snooze. |
| expiryDays | Auto-expire after (working days) | Text | Optional. Auto-expire created TODOs after N working days. Leave blank to disable. |
| defaultUsers | Responsible Users | Preset Value(s) | Default responsible users; applied on creation. |
| defaultDepartments | Responsible Departments | Preset Value(s) | Default responsible departments; applied on creation. |
| id | TODO Auto Rule ID | Text |