--- title: "Create Postmortem Status" method: POST path: "/incident-postmortem-status" tags: ["Postmortem Status"] --- # Create Postmortem Status `POST /incident-postmortem-status` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/incident-postmortem-status` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to create a new Postmortem Status ## Request body - object - `data` IncidentPostmortemStatusCreateSchema, required: Create schema for IncidentPostmortemStatus model. Create - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [No access - you don't have permission for this operation] - `name` string, required: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `color` object, required: Color of this resource in Hex (#32a852 for example). Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `isNotStartedStatus` boolean: Is it the status a new incident's postmortem starts in? A project has one, and it can't be deleted or archived. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `isDraftStatus` boolean: Is it the status a postmortem moves to once its note is written? A project has one, and it can't be deleted or archived. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `isCompletedStatus` boolean: Is it the status a postmortem moves to once it is published on a status page? A postmortem in this status, or in one below it, counts as done. A project has one, and it can't be deleted or archived. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `order` integer: Where this status sits in the project's list of postmortem statuses: 1 is the top. A postmortem in the completed status, or in a status below it, counts as done; one above it is still owed. So the not started, draft and completed statuses have to stay in that order. A new status without a number goes just above the completed status. Setting a number moves the status to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `isArchived` boolean: Archived statuses stay on the incidents whose postmortems are in them, but can't be picked again. The not started, draft and completed statuses can't be archived. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] ## Response `201` Created successfully - object - `data` IncidentPostmortemStatusReadSchema: Read schema for IncidentPostmortemStatus model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [No access - you don't have permission for this operation] - `name` string, required: Any friendly name of this object. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `slug` string: Friendly globally unique name for your object. 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 Postmortem Status], Update: [No access - you don't have permission for this operation] - `description` string: Friendly description that will help you remember. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `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 Postmortem Status], Update: [No access - you don't have permission for this operation] - `deletedByUserId` string, uuid: User ID who deleted this object (if this object was deleted 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 Postmortem Status], Update: [No access - you don't have permission for this operation] - `color` object, required: Color of this resource in Hex (#32a852 for example). Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `isNotStartedStatus` boolean: Is it the status a new incident's postmortem starts in? A project has one, and it can't be deleted or archived. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `isDraftStatus` boolean: Is it the status a postmortem moves to once its note is written? A project has one, and it can't be deleted or archived. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `isCompletedStatus` boolean: Is it the status a postmortem moves to once it is published on a status page? A postmortem in this status, or in one below it, counts as done. A project has one, and it can't be deleted or archived. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `order` integer: Where this status sits in the project's list of postmortem statuses: 1 is the top. A postmortem in the completed status, or in a status below it, counts as done; one above it is still owed. So the not started, draft and completed statuses have to stay in that order. A new status without a number goes just above the completed status. Setting a number moves the status to that place, and the ones in between shift by one. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `isArchived` boolean: Archived statuses stay on the incidents whose postmortems are in them, but can't be picked again. The not started, draft and completed statuses can't be archived. Permissions - Create: [Project Owner, Project Admin, Incident Admin, Create Postmortem Status], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Postmortem Status], Update: [Project Owner, Project Admin, Incident Admin, Edit Postmortem Status] - `archivedAt` object: When this postmortem status was archived. Empty while it is not archived. 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 Postmortem Status], Update: [No access - you don't have permission for this operation] - `archivedByUserId` string, uuid: User ID who archived this object (if this object was archived 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 Postmortem Status], 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)