> For the complete documentation index, see [llms.txt](https://docs.xibosignage.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.xibosignage.com/developer/integrate/openapi/notification.md).

# Notification

Notifications

## Notification Search

> Search this users Notifications

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"notification","description":"Notifications"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"Notification":{"properties":{"notificationId":{"description":"The Notifcation ID","type":"integer"},"createDt":{"description":"Create Date as Unix Timestamp","type":"integer"},"releaseDt":{"description":"Release Date as Unix Timestamp","type":"integer"},"subject":{"description":"The subject line","type":"string"},"type":{"description":"The Notification type","type":"string"},"body":{"description":"The HTML body of the notification","type":"string"},"isInterrupt":{"description":"Should the notification interrupt the CMS UI on navigate/login","type":"integer"},"isSystem":{"description":"Flag for system notification","type":"integer"},"userId":{"description":"The Owner User Id","type":"integer"},"filename":{"description":"Attachment filename","type":"string"},"originalFileName":{"description":"Attachment originalFileName","type":"string"},"nonusers":{"description":"Additional email addresses to which a saved report will be sent","type":"string"},"userGroups":{"description":"User Group Notifications associated with this notification","type":"array","items":{"$ref":"#/components/schemas/UserGroup"}},"displayGroups":{"description":"Display Groups associated with this notification","type":"array","items":{"$ref":"#/components/schemas/DisplayGroup"}}}},"UserGroup":{"properties":{"groupId":{"description":"The Group ID","type":"integer"},"group":{"description":"The group name","type":"string"},"isUserSpecific":{"description":"A flag indicating whether this is a user specific group or not","type":"integer"},"isEveryone":{"description":"A flag indicating the special everyone group","type":"integer"},"description":{"description":"Description of this User Group","type":"string"},"libraryQuota":{"description":"This users library quota in bytes. 0 = unlimited","type":"integer"},"isSystemNotification":{"description":"Does this Group receive system notifications.","type":"integer"},"isDisplayNotification":{"description":"Does this Group receive display notifications.","type":"integer"},"isDataSetNotification":{"description":"Does this Group receive DataSet notifications.","type":"integer"},"isLayoutNotification":{"description":"Does this Group receive Layout notifications.","type":"integer"},"isLibraryNotification":{"description":"Does this Group receive Library notifications.","type":"integer"},"isReportNotification":{"description":"Does this Group receive Report notifications.","type":"integer"},"isScheduleNotification":{"description":"Does this Group receive Schedule notifications.","type":"integer"},"isCustomNotification":{"description":"Does this Group receive Custom notifications.","type":"integer"},"isShownForAddUser":{"description":"Is this Group shown in the list of choices when onboarding a new user","type":"integer"},"defaultHomepageId":{"description":"Default Home page for new users","type":"string"},"features":{"description":"Features this User Group has direct access to","type":"array","items":{"type":"string"}}}},"DisplayGroup":{"properties":{"displayGroupId":{"description":"The displayGroup Id","type":"integer"},"displayGroup":{"description":"The displayGroup Name","type":"string"},"description":{"description":"The displayGroup Description","type":"string"},"isDisplaySpecific":{"description":"A flag indicating whether this displayGroup is a single display displayGroup","type":"integer"},"isDynamic":{"description":"A flag indicating whether this displayGroup is dynamic","type":"integer"},"dynamicCriteria":{"description":"Criteria for this dynamic group. A comma separated set of regular expressions to apply","type":"string"},"dynamicCriteriaLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND","type":"string"},"dynamicCriteriaTags":{"description":"Criteria for this dynamic group. A comma separated set of tags to apply","type":"string"},"dynamicCriteriaExactTags":{"description":"Flag indicating whether to filter by exact Tag match","type":"integer"},"dynamicCriteriaTagsLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple Tags? OR|AND","type":"string"},"userId":{"description":"The UserId who owns this display group","type":"integer"},"tags":{"description":"Tags associated with this Display Group, array of TagLink objects","type":"array","items":{"$ref":"#/components/schemas/TagLink"}},"bandwidthLimit":{"description":"The display bandwidth limit","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of groups/users with permissions to this DisplayGroup","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string"},"folderId":{"description":"The id of the Folder this Display Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Display Group","type":"integer"},"ref1":{"description":"Optional Reference 1","type":"string"},"ref2":{"description":"Optional Reference 2","type":"string"},"ref3":{"description":"Optional Reference 3","type":"string"},"ref4":{"description":"Optional Reference 4","type":"string"},"ref5":{"description":"Optional Reference 5","type":"string"}}},"TagLink":{"properties":{"tag":{"description":"The Tag","type":"string"},"tagId":{"description":"The Tag ID","type":"integer"},"value":{"description":"The Tag Value","type":"string"}}}}},"paths":{"/notification":{"get":{"tags":["notification"],"summary":"Notification Search","description":"Search this users Notifications","operationId":"notificationSearch","parameters":[{"schema":{"type":"integer"},"name":"notificationId","in":"query","description":"Filter by Notification Id","required":false},{"schema":{"type":"string"},"name":"subject","in":"query","description":"Filter by Subject","required":false},{"schema":{"type":"string"},"name":"embed","in":"query","description":"Embed related data such as userGroups,displayGroups","required":false}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}}}}}}}}}}
```

## Notification Add

> Add a Notification

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"notification","description":"Notifications"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"Notification":{"properties":{"notificationId":{"description":"The Notifcation ID","type":"integer"},"createDt":{"description":"Create Date as Unix Timestamp","type":"integer"},"releaseDt":{"description":"Release Date as Unix Timestamp","type":"integer"},"subject":{"description":"The subject line","type":"string"},"type":{"description":"The Notification type","type":"string"},"body":{"description":"The HTML body of the notification","type":"string"},"isInterrupt":{"description":"Should the notification interrupt the CMS UI on navigate/login","type":"integer"},"isSystem":{"description":"Flag for system notification","type":"integer"},"userId":{"description":"The Owner User Id","type":"integer"},"filename":{"description":"Attachment filename","type":"string"},"originalFileName":{"description":"Attachment originalFileName","type":"string"},"nonusers":{"description":"Additional email addresses to which a saved report will be sent","type":"string"},"userGroups":{"description":"User Group Notifications associated with this notification","type":"array","items":{"$ref":"#/components/schemas/UserGroup"}},"displayGroups":{"description":"Display Groups associated with this notification","type":"array","items":{"$ref":"#/components/schemas/DisplayGroup"}}}},"UserGroup":{"properties":{"groupId":{"description":"The Group ID","type":"integer"},"group":{"description":"The group name","type":"string"},"isUserSpecific":{"description":"A flag indicating whether this is a user specific group or not","type":"integer"},"isEveryone":{"description":"A flag indicating the special everyone group","type":"integer"},"description":{"description":"Description of this User Group","type":"string"},"libraryQuota":{"description":"This users library quota in bytes. 0 = unlimited","type":"integer"},"isSystemNotification":{"description":"Does this Group receive system notifications.","type":"integer"},"isDisplayNotification":{"description":"Does this Group receive display notifications.","type":"integer"},"isDataSetNotification":{"description":"Does this Group receive DataSet notifications.","type":"integer"},"isLayoutNotification":{"description":"Does this Group receive Layout notifications.","type":"integer"},"isLibraryNotification":{"description":"Does this Group receive Library notifications.","type":"integer"},"isReportNotification":{"description":"Does this Group receive Report notifications.","type":"integer"},"isScheduleNotification":{"description":"Does this Group receive Schedule notifications.","type":"integer"},"isCustomNotification":{"description":"Does this Group receive Custom notifications.","type":"integer"},"isShownForAddUser":{"description":"Is this Group shown in the list of choices when onboarding a new user","type":"integer"},"defaultHomepageId":{"description":"Default Home page for new users","type":"string"},"features":{"description":"Features this User Group has direct access to","type":"array","items":{"type":"string"}}}},"DisplayGroup":{"properties":{"displayGroupId":{"description":"The displayGroup Id","type":"integer"},"displayGroup":{"description":"The displayGroup Name","type":"string"},"description":{"description":"The displayGroup Description","type":"string"},"isDisplaySpecific":{"description":"A flag indicating whether this displayGroup is a single display displayGroup","type":"integer"},"isDynamic":{"description":"A flag indicating whether this displayGroup is dynamic","type":"integer"},"dynamicCriteria":{"description":"Criteria for this dynamic group. A comma separated set of regular expressions to apply","type":"string"},"dynamicCriteriaLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND","type":"string"},"dynamicCriteriaTags":{"description":"Criteria for this dynamic group. A comma separated set of tags to apply","type":"string"},"dynamicCriteriaExactTags":{"description":"Flag indicating whether to filter by exact Tag match","type":"integer"},"dynamicCriteriaTagsLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple Tags? OR|AND","type":"string"},"userId":{"description":"The UserId who owns this display group","type":"integer"},"tags":{"description":"Tags associated with this Display Group, array of TagLink objects","type":"array","items":{"$ref":"#/components/schemas/TagLink"}},"bandwidthLimit":{"description":"The display bandwidth limit","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of groups/users with permissions to this DisplayGroup","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string"},"folderId":{"description":"The id of the Folder this Display Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Display Group","type":"integer"},"ref1":{"description":"Optional Reference 1","type":"string"},"ref2":{"description":"Optional Reference 2","type":"string"},"ref3":{"description":"Optional Reference 3","type":"string"},"ref4":{"description":"Optional Reference 4","type":"string"},"ref5":{"description":"Optional Reference 5","type":"string"}}},"TagLink":{"properties":{"tag":{"description":"The Tag","type":"string"},"tagId":{"description":"The Tag ID","type":"integer"},"value":{"description":"The Tag Value","type":"string"}}}}},"paths":{"/notification":{"post":{"tags":["notification"],"summary":"Notification Add","description":"Add a Notification","operationId":"notificationAdd","responses":{"201":{"description":"successful operation","headers":{"Location":{"description":"Location of the new record","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"subject":{"type":"string","description":"The Subject"},"body":{"type":"string","description":"The Body"},"releaseDt":{"type":"string","description":"ISO date representing the release date for this notification"},"isInterrupt":{"type":"integer","description":"Flag indication whether this notification should interrupt the web portal nativation/login"},"displayGroupIds":{"type":"array","description":"The display group ids to assign this notification to"},"userGroupIds":{"type":"array","description":"The user group ids to assign to this notification"}},"required":["subject","isInterrupt","displayGroupIds","userGroupIds"]}}}}}}}}
```

## Notification Edit

> Edit a Notification

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"notification","description":"Notifications"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}},"schemas":{"Notification":{"properties":{"notificationId":{"description":"The Notifcation ID","type":"integer"},"createDt":{"description":"Create Date as Unix Timestamp","type":"integer"},"releaseDt":{"description":"Release Date as Unix Timestamp","type":"integer"},"subject":{"description":"The subject line","type":"string"},"type":{"description":"The Notification type","type":"string"},"body":{"description":"The HTML body of the notification","type":"string"},"isInterrupt":{"description":"Should the notification interrupt the CMS UI on navigate/login","type":"integer"},"isSystem":{"description":"Flag for system notification","type":"integer"},"userId":{"description":"The Owner User Id","type":"integer"},"filename":{"description":"Attachment filename","type":"string"},"originalFileName":{"description":"Attachment originalFileName","type":"string"},"nonusers":{"description":"Additional email addresses to which a saved report will be sent","type":"string"},"userGroups":{"description":"User Group Notifications associated with this notification","type":"array","items":{"$ref":"#/components/schemas/UserGroup"}},"displayGroups":{"description":"Display Groups associated with this notification","type":"array","items":{"$ref":"#/components/schemas/DisplayGroup"}}}},"UserGroup":{"properties":{"groupId":{"description":"The Group ID","type":"integer"},"group":{"description":"The group name","type":"string"},"isUserSpecific":{"description":"A flag indicating whether this is a user specific group or not","type":"integer"},"isEveryone":{"description":"A flag indicating the special everyone group","type":"integer"},"description":{"description":"Description of this User Group","type":"string"},"libraryQuota":{"description":"This users library quota in bytes. 0 = unlimited","type":"integer"},"isSystemNotification":{"description":"Does this Group receive system notifications.","type":"integer"},"isDisplayNotification":{"description":"Does this Group receive display notifications.","type":"integer"},"isDataSetNotification":{"description":"Does this Group receive DataSet notifications.","type":"integer"},"isLayoutNotification":{"description":"Does this Group receive Layout notifications.","type":"integer"},"isLibraryNotification":{"description":"Does this Group receive Library notifications.","type":"integer"},"isReportNotification":{"description":"Does this Group receive Report notifications.","type":"integer"},"isScheduleNotification":{"description":"Does this Group receive Schedule notifications.","type":"integer"},"isCustomNotification":{"description":"Does this Group receive Custom notifications.","type":"integer"},"isShownForAddUser":{"description":"Is this Group shown in the list of choices when onboarding a new user","type":"integer"},"defaultHomepageId":{"description":"Default Home page for new users","type":"string"},"features":{"description":"Features this User Group has direct access to","type":"array","items":{"type":"string"}}}},"DisplayGroup":{"properties":{"displayGroupId":{"description":"The displayGroup Id","type":"integer"},"displayGroup":{"description":"The displayGroup Name","type":"string"},"description":{"description":"The displayGroup Description","type":"string"},"isDisplaySpecific":{"description":"A flag indicating whether this displayGroup is a single display displayGroup","type":"integer"},"isDynamic":{"description":"A flag indicating whether this displayGroup is dynamic","type":"integer"},"dynamicCriteria":{"description":"Criteria for this dynamic group. A comma separated set of regular expressions to apply","type":"string"},"dynamicCriteriaLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple dynamic criteria? OR|AND","type":"string"},"dynamicCriteriaTags":{"description":"Criteria for this dynamic group. A comma separated set of tags to apply","type":"string"},"dynamicCriteriaExactTags":{"description":"Flag indicating whether to filter by exact Tag match","type":"integer"},"dynamicCriteriaTagsLogicalOperator":{"description":"Which logical operator should be used when filtering by multiple Tags? OR|AND","type":"string"},"userId":{"description":"The UserId who owns this display group","type":"integer"},"tags":{"description":"Tags associated with this Display Group, array of TagLink objects","type":"array","items":{"$ref":"#/components/schemas/TagLink"}},"bandwidthLimit":{"description":"The display bandwidth limit","type":"integer"},"groupsWithPermissions":{"description":"A comma separated list of groups/users with permissions to this DisplayGroup","type":"string"},"createdDt":{"description":"The datetime this entity was created","type":"string"},"modifiedDt":{"description":"The datetime this entity was last modified","type":"string"},"folderId":{"description":"The id of the Folder this Display Group belongs to","type":"integer"},"permissionsFolderId":{"description":"The id of the Folder responsible for providing permissions for this Display Group","type":"integer"},"ref1":{"description":"Optional Reference 1","type":"string"},"ref2":{"description":"Optional Reference 2","type":"string"},"ref3":{"description":"Optional Reference 3","type":"string"},"ref4":{"description":"Optional Reference 4","type":"string"},"ref5":{"description":"Optional Reference 5","type":"string"}}},"TagLink":{"properties":{"tag":{"description":"The Tag","type":"string"},"tagId":{"description":"The Tag ID","type":"integer"},"value":{"description":"The Tag Value","type":"string"}}}}},"paths":{"/notification/{notificationId}":{"put":{"tags":["notification"],"summary":"Notification Edit","description":"Edit a Notification","operationId":"notificationEdit","parameters":[{"schema":{"type":"integer"},"name":"notificationId","in":"path","description":"The NotificationId","required":true}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Notification"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"subject":{"type":"string","description":"The Subject"},"body":{"type":"string","description":"The Body"},"releaseDt":{"type":"string","description":"ISO date representing the release date for this notification"},"isInterrupt":{"type":"integer","description":"Flag indication whether this notification should interrupt the web portal nativation/login"},"displayGroupIds":{"type":"array","description":"The display group ids to assign this notification to"},"userGroupIds":{"type":"array","description":"The user group ids to assign to this notification"}},"required":["subject","releaseDt","isInterrupt","displayGroupIds","userGroupIds"]}}}}}}}}
```

## Delete Notification

> Delete the provided notification

```json
{"openapi":"3.1.1","info":{"title":"Xibo API","version":"4.0"},"tags":[{"name":"notification","description":"Notifications"}],"servers":[{"url":"/api"}],"security":[{"auth":["write:all","read:all"]}],"components":{"securitySchemes":{"auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"/api/authorize","tokenUrl":"/api/authorize/access_token","scopes":{"read:all":"read access","write:all":"write access"}}}}}},"paths":{"/notification/{notificationId}":{"delete":{"tags":["notification"],"summary":"Delete Notification","description":"Delete the provided notification","operationId":"notificationDelete","parameters":[{"schema":{"type":"integer"},"name":"notificationId","in":"path","description":"The Notification Id to Delete","required":true}],"responses":{"204":{"description":"successful operation"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.xibosignage.com/developer/integrate/openapi/notification.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.