--- title: "Create Incident Reminder Rule" method: POST path: "/incident-reminder-rule" tags: ["Incident Reminder Rule"] --- # Create Incident Reminder Rule `POST /incident-reminder-rule` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/incident-reminder-rule` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to create a new Incident Reminder Rule ## Request body - object - `data` IncidentReminderRuleCreateSchema, required: Create schema for IncidentReminderRule model. Create - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident 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 Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `description` string: Description of this reminder rule. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident 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 Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `isEnabled` boolean: Whether this reminder rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `reminderIntervalInMinutes` number, required: How often (in minutes) to remind incident owners while the incident is still open. For example, set to 30 to remind owners every 30 minutes. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `stopRemindersOnState` 'Acknowledged' | 'Resolved': Stop sending reminders once the incident reaches this state. Select Acknowledged to stop reminders when the incident is acknowledged, or Resolved to keep reminding until the incident is resolved. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `incidentSeverities` object[]: Only apply this reminder rule to incidents with these severities. Leave empty to match incidents of any severity. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `id` string - `labels` object[]: Only apply this reminder rule to incidents with these labels. Leave empty to match incidents with any labels. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `id` string ## Response `201` Created successfully - object - `data` IncidentReminderRuleReadSchema: Read schema for IncidentReminderRule model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident 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 Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `description` string: Description of this reminder rule. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident 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 Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `isEnabled` boolean: Whether this reminder rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `reminderIntervalInMinutes` number, required: How often (in minutes) to remind incident owners while the incident is still open. For example, set to 30 to remind owners every 30 minutes. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `stopRemindersOnState` 'Acknowledged' | 'Resolved': Stop sending reminders once the incident reaches this state. Select Acknowledged to stop reminders when the incident is acknowledged, or Resolved to keep reminding until the incident is resolved. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `incidentSeverities` object[]: Only apply this reminder rule to incidents with these severities. Leave empty to match incidents of any severity. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident Reminder Rule] - `id` string - `labels` object[]: Only apply this reminder rule to incidents with these labels. Leave empty to match incidents with any labels. Permissions - Create: [Project Owner, Project Admin, Create Incident Reminder Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Reminder Rule], Update: [Project Owner, Project Admin, Edit Incident 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, Incident Admin, Incident Member, Incident Viewer, Read Incident 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. - `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)