--- title: "Create Incident Public Note" method: POST path: "/incident-public-note" tags: ["Incident Public Note"] --- # Create Incident Public Note `POST /incident-public-note` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/incident-public-note` - 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 Public Note ## Request body - object - `data` IncidentPublicNoteCreateSchema, required: Create schema for IncidentPublicNote model. Create - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [No access - you don't have permission for this operation] - `incidentId` string, uuid, required: Relation to Incident ID in which this resource belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [No access - you don't have permission for this operation] - `note` string: Notes in markdown. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `attachments` object[]: Files attached to this note. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `id` string - `shouldStatusPageSubscribersBeNotifiedOnNoteCreated` boolean: Should subscribers be notified about this note? If left out, this follows the incident: true when subscribers were notified that the incident was declared, false when it was declared without notifying them. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [No access - you don't have permission for this operation] - `postedAt` object: Date and time when the note was posted. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `postedFromSlackMessageId` string: Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [No access - you don't have permission for this operation] ## Response `201` Created successfully - object - `data` IncidentPublicNoteReadSchema: Read schema for IncidentPublicNote model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [No access - you don't have permission for this operation] - `incidentId` string, uuid, required: Relation to Incident ID in which this resource belongs. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [No access - you don't have permission for this operation] - `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 Status Page Note], Update: [No access - you don't have permission for this operation] - `note` string: Notes in markdown. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `attachments` object[]: Files attached to this note. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `id` string - `subscriberNotificationStatusMessage` string: Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `shouldStatusPageSubscribersBeNotifiedOnNoteCreated` boolean: Should subscribers be notified about this note? If left out, this follows the incident: true when subscribers were notified that the incident was declared, false when it was declared without notifying them. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [No access - you don't have permission for this operation] - `postedAt` object: Date and time when the note was posted. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Edit Incident Status Page Note] - `postedFromSlackMessageId` string: Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message. Permissions - Create: [Project Owner, Project Admin, Project Member, Incident Admin, Incident Member, Create Incident Status Page Note], Read: [Project Owner, Project Admin, Project Member, Viewer, Incident Admin, Incident Member, Incident Viewer, Read Incident Status Page Note], Update: [No access - you don't have permission for this operation] - `savedFromChatMessage` object: When this note was saved from a Slack or Microsoft Teams message - pinned, or given a note emoji - the chat it was posted in (workspaceType), who wrote it (authorName, and authorUserId when their chat account is connected to OneUptime) and when it was posted there (postedAt). Written by OneUptime; the note's creator is whoever saved it. 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 Status Page Note], 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)