--- title: "Update Scheduled Maintenance Reminder Rule" method: PUT path: "/scheduled-maintenance-reminder-rule/{id}" tags: ["Scheduled Maintenance Reminder Rule"] --- # Update Scheduled Maintenance Reminder Rule `PUT /scheduled-maintenance-reminder-rule/{id}` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/scheduled-maintenance-reminder-rule/{id}` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to update an existing Scheduled Maintenance Reminder Rule ## Path parameters - `id` string, uuid, required ## Request body - object - `data` ScheduledMaintenanceReminderRuleUpdateSchema, required: Update schema for ScheduledMaintenanceReminderRule model. Update - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `name` string: Name of this reminder rule. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `description` string: Description of this reminder rule. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `order` number: Where this rule sits in the list. Rules are evaluated from the top of the list down, lowest number first, and the first one that matches wins. A new rule is added to the end of the list. Setting a number another one already has puts it in that place, and the ones in the way move one place along to make room. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `isEnabled` boolean: Whether this reminder rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `reminderIntervalInMinutes` number: How often (in minutes) to remind scheduled maintenance event owners while the event is still not complete. For example, set to 30 to remind owners every 30 minutes. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `stopRemindersOnState` 'Ongoing' | 'Completed': Stop sending reminders once the scheduled maintenance event reaches this state. Select Ongoing to stop reminders when the event starts, or Completed to keep reminding until the event is completed. Ongoing needs Remind While Event is Scheduled on: a rule that waits for the event to start and stops when it starts would never remind, so it is refused. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `remindWhileScheduled` boolean: Send reminders while the event is still scheduled (before it starts). When disabled, reminders only begin once the event has started. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `labels` object[]: Only apply this reminder rule to scheduled maintenance events with these labels. Leave empty to match all events. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `id` string ## Response `200` Updated successfully - object - `data` ScheduledMaintenanceReminderRuleReadSchema: Read schema for ScheduledMaintenanceReminderRule model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this reminder rule. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `description` string: Description of this reminder rule. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `order` number: Where this rule sits in the list. Rules are evaluated from the top of the list down, lowest number first, and the first one that matches wins. A new rule is added to the end of the list. Setting a number another one already has puts it in that place, and the ones in the way move one place along to make room. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `isEnabled` boolean: Whether this reminder rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `reminderIntervalInMinutes` number, required: How often (in minutes) to remind scheduled maintenance event owners while the event is still not complete. For example, set to 30 to remind owners every 30 minutes. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `stopRemindersOnState` 'Ongoing' | 'Completed': Stop sending reminders once the scheduled maintenance event reaches this state. Select Ongoing to stop reminders when the event starts, or Completed to keep reminding until the event is completed. Ongoing needs Remind While Event is Scheduled on: a rule that waits for the event to start and stops when it starts would never remind, so it is refused. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `remindWhileScheduled` boolean: Send reminders while the event is still scheduled (before it starts). When disabled, reminders only begin once the event has started. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `labels` object[]: Only apply this reminder rule to scheduled maintenance events with these labels. Leave empty to match all events. Permissions - Create: [Project Owner, Project Admin, Create Scheduled Maintenance Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [Project Owner, Project Admin, Edit Scheduled Maintenance Reminder Rule] - `id` string - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Scheduled Maintenance Admin, Scheduled Maintenance Member, Scheduled Maintenance Viewer, Read Scheduled Maintenance Reminder Rule], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)