> For the complete documentation index, see [llms.txt](https://docs.mulearn.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mulearn.org/api-reference/notification.md).

# Notification

## POST /api/v1/notification/broadcast/create/

> Admin only. Create a new global broadcast announcement.

```json
{"openapi":"3.0.3","info":{"title":"muLearn API","version":"1.0.0"},"security":[{"jwtAuth":[]},{}],"components":{"securitySchemes":{"jwtAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT Token Authentication. Enter **\"Bearer <token>\"**"}},"schemas":{"BroadcastNotificationAdmin":{"type":"object","description":"Extended serializer for admin CRUD on BroadcastNotification.\nAdds a `target_details` field that resolves the human-readable name of\nthe target entity from target_type + target_id.","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":200},"url":{"type":"string","nullable":true,"maxLength":100},"target_type":{"type":"string","maxLength":30},"target_id":{"type":"string","nullable":true,"maxLength":36},"target_details":{"type":"string","readOnly":true},"created_by":{"type":"string","readOnly":true},"created_by_name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"expires_at":{"type":"string","format":"date-time"}},"required":["created_at","created_by","created_by_name","description","expires_at","id","target_details","target_type","title"]}}},"paths":{"/api/v1/notification/broadcast/create/":{"post":{"operationId":"notification_broadcast_create_create","description":"Admin only. Create a new global broadcast announcement.","tags":["Notification"],"responses":{"201":{"content":{"application/json":{"schema":{"type":"object","properties":{"hasError":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":200},"message":{"type":"object","properties":{"general":{"type":"array","items":{"type":"string"}}}},"response":{"$ref":"#/components/schemas/BroadcastNotificationAdmin"}},"required":["hasError","statusCode","message","response"]}}},"description":""}}}}}}
```

## DELETE /api/v1/notification/broadcast/delete/all/

> Delete all broadcast notifications. Admin role required.

```json
{"openapi":"3.0.3","info":{"title":"muLearn API","version":"1.0.0"},"security":[{"jwtAuth":[]},{}],"components":{"securitySchemes":{"jwtAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT Token Authentication. Enter **\"Bearer <token>\"**"}},"schemas":{"BroadcastNotification":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":200},"url":{"type":"string","nullable":true,"maxLength":100},"target_type":{"type":"string","maxLength":30},"target_id":{"type":"string","nullable":true,"maxLength":36},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"}},"required":["created_at","created_by","description","expires_at","id","target_type","title"]}}},"paths":{"/api/v1/notification/broadcast/delete/all/":{"delete":{"operationId":"notification_broadcast_delete_all_destroy","description":"Delete all broadcast notifications. Admin role required.","tags":["Notification"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"hasError":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":200},"message":{"type":"object","properties":{"general":{"type":"array","items":{"type":"string"}}}},"response":{"$ref":"#/components/schemas/BroadcastNotification"}},"required":["hasError","statusCode","message","response"]}}},"description":""}}}}}}
```

## DELETE /api/v1/notification/broadcast/delete/id/{broadcast\_id}/

> Delete a single broadcast notification by its ID. Admin role required.

```json
{"openapi":"3.0.3","info":{"title":"muLearn API","version":"1.0.0"},"security":[{"jwtAuth":[]},{}],"components":{"securitySchemes":{"jwtAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT Token Authentication. Enter **\"Bearer <token>\"**"}},"schemas":{"BroadcastNotification":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":200},"url":{"type":"string","nullable":true,"maxLength":100},"target_type":{"type":"string","maxLength":30},"target_id":{"type":"string","nullable":true,"maxLength":36},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"}},"required":["created_at","created_by","description","expires_at","id","target_type","title"]}}},"paths":{"/api/v1/notification/broadcast/delete/id/{broadcast_id}/":{"delete":{"operationId":"notification_broadcast_delete_id_destroy","description":"Delete a single broadcast notification by its ID. Admin role required.","parameters":[{"in":"path","name":"broadcast_id","schema":{"type":"string"},"required":true}],"tags":["Notification"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"hasError":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":200},"message":{"type":"object","properties":{"general":{"type":"array","items":{"type":"string"}}}},"response":{"$ref":"#/components/schemas/BroadcastNotification"}},"required":["hasError","statusCode","message","response"]}}},"description":""}}}}}}
```

## GET /api/v1/notification/broadcast/list/all/

> Admin only. List all broadcast notifications. Each record includes a \`target\_details\` field with the resolved human-readable name of the target audience.

```json
{"openapi":"3.0.3","info":{"title":"muLearn API","version":"1.0.0"},"security":[{"jwtAuth":[]},{}],"components":{"securitySchemes":{"jwtAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT Token Authentication. Enter **\"Bearer <token>\"**"}},"schemas":{"BroadcastNotificationAdmin":{"type":"object","description":"Extended serializer for admin CRUD on BroadcastNotification.\nAdds a `target_details` field that resolves the human-readable name of\nthe target entity from target_type + target_id.","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":200},"url":{"type":"string","nullable":true,"maxLength":100},"target_type":{"type":"string","maxLength":30},"target_id":{"type":"string","nullable":true,"maxLength":36},"target_details":{"type":"string","readOnly":true},"created_by":{"type":"string","readOnly":true},"created_by_name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"expires_at":{"type":"string","format":"date-time"}},"required":["created_at","created_by","created_by_name","description","expires_at","id","target_details","target_type","title"]}}},"paths":{"/api/v1/notification/broadcast/list/all/":{"get":{"operationId":"notification_broadcast_list_all_list","description":"Admin only. List all broadcast notifications. Each record includes a `target_details` field with the resolved human-readable name of the target audience.","tags":["Notification"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"hasError":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":200},"message":{"type":"object","properties":{"general":{"type":"array","items":{"type":"string"}}}},"response":{"type":"array","items":{"$ref":"#/components/schemas/BroadcastNotificationAdmin"}}},"required":["hasError","statusCode","message","response"]}}},"description":""}}}}}}
```

## PATCH /api/v1/notification/broadcast/update/id/{broadcast\_id}/

> Admin only. Partially update a broadcast notification by its ID. All fields are optional.

```json
{"openapi":"3.0.3","info":{"title":"muLearn API","version":"1.0.0"},"security":[{"jwtAuth":[]},{}],"components":{"securitySchemes":{"jwtAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT Token Authentication. Enter **\"Bearer <token>\"**"}},"schemas":{"BroadcastNotificationAdmin":{"type":"object","description":"Extended serializer for admin CRUD on BroadcastNotification.\nAdds a `target_details` field that resolves the human-readable name of\nthe target entity from target_type + target_id.","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":200},"url":{"type":"string","nullable":true,"maxLength":100},"target_type":{"type":"string","maxLength":30},"target_id":{"type":"string","nullable":true,"maxLength":36},"target_details":{"type":"string","readOnly":true},"created_by":{"type":"string","readOnly":true},"created_by_name":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"expires_at":{"type":"string","format":"date-time"}},"required":["created_at","created_by","created_by_name","description","expires_at","id","target_details","target_type","title"]}}},"paths":{"/api/v1/notification/broadcast/update/id/{broadcast_id}/":{"patch":{"operationId":"notification_broadcast_update_id_partial_update","description":"Admin only. Partially update a broadcast notification by its ID. All fields are optional.","parameters":[{"in":"path","name":"broadcast_id","schema":{"type":"string"},"required":true}],"tags":["Notification"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"hasError":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":200},"message":{"type":"object","properties":{"general":{"type":"array","items":{"type":"string"}}}},"response":{"$ref":"#/components/schemas/BroadcastNotificationAdmin"}},"required":["hasError","statusCode","message","response"]}}},"description":""}}}}}}
```

## DELETE /api/v1/notification/delete/all/

> Delete Notification Delete All.

```json
{"openapi":"3.0.3","info":{"title":"muLearn API","version":"1.0.0"},"security":[{"jwtAuth":[]},{}],"components":{"securitySchemes":{"jwtAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT Token Authentication. Enter **\"Bearer <token>\"**"}},"schemas":{"Notification":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":200},"button":{"type":"string","nullable":true,"maxLength":10},"url":{"type":"string","nullable":true,"maxLength":100},"created_at":{"type":"string","format":"date-time","readOnly":true},"user":{"type":"string"},"created_by":{"type":"string"}},"required":["created_at","created_by","description","id","title","user"]}}},"paths":{"/api/v1/notification/delete/all/":{"delete":{"operationId":"notification_delete_all_destroy","description":"Delete Notification Delete All.","tags":["Notification"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"hasError":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":200},"message":{"type":"object","properties":{"general":{"type":"array","items":{"type":"string"}}}},"response":{"$ref":"#/components/schemas/Notification"}},"required":["hasError","statusCode","message","response"]}}},"description":""}}}}}}
```

## DELETE /api/v1/notification/delete/id/{notification\_id}/

> Delete Notification Delete.

```json
{"openapi":"3.0.3","info":{"title":"muLearn API","version":"1.0.0"},"security":[{"jwtAuth":[]},{}],"components":{"securitySchemes":{"jwtAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT Token Authentication. Enter **\"Bearer <token>\"**"}},"schemas":{"Notification":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":200},"button":{"type":"string","nullable":true,"maxLength":10},"url":{"type":"string","nullable":true,"maxLength":100},"created_at":{"type":"string","format":"date-time","readOnly":true},"user":{"type":"string"},"created_by":{"type":"string"}},"required":["created_at","created_by","description","id","title","user"]}}},"paths":{"/api/v1/notification/delete/id/{notification_id}/":{"delete":{"operationId":"notification_delete_id_destroy","description":"Delete Notification Delete.","parameters":[{"in":"path","name":"notification_id","schema":{"type":"string"},"required":true}],"tags":["Notification"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"hasError":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":200},"message":{"type":"object","properties":{"general":{"type":"array","items":{"type":"string"}}}},"response":{"$ref":"#/components/schemas/Notification"}},"required":["hasError","statusCode","message","response"]}}},"description":""}}}}}}
```

## GET /api/v1/notification/list/

> Retrieve all notifications for the authenticated user. Returns two lists: \`direct\` (personal) and \`broadcasts\` (group/audience).

```json
{"openapi":"3.0.3","info":{"title":"muLearn API","version":"1.0.0"},"security":[{"jwtAuth":[]},{}],"components":{"securitySchemes":{"jwtAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"JWT Token Authentication. Enter **\"Bearer <token>\"**"}},"schemas":{"NotificationListResponse":{"type":"object","properties":{"direct":{"type":"array","items":{"$ref":"#/components/schemas/Notification"}},"broadcasts":{"type":"array","items":{"$ref":"#/components/schemas/BroadcastNotification"}}},"required":["broadcasts","direct"]},"Notification":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":200},"button":{"type":"string","nullable":true,"maxLength":10},"url":{"type":"string","nullable":true,"maxLength":100},"created_at":{"type":"string","format":"date-time","readOnly":true},"user":{"type":"string"},"created_by":{"type":"string"}},"required":["created_at","created_by","description","id","title","user"]},"BroadcastNotification":{"type":"object","properties":{"id":{"type":"string","format":"uuid","readOnly":true},"title":{"type":"string","maxLength":50},"description":{"type":"string","maxLength":200},"url":{"type":"string","nullable":true,"maxLength":100},"target_type":{"type":"string","maxLength":30},"target_id":{"type":"string","nullable":true,"maxLength":36},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"}},"required":["created_at","created_by","description","expires_at","id","target_type","title"]}}},"paths":{"/api/v1/notification/list/":{"get":{"operationId":"notification_list_retrieve","description":"Retrieve all notifications for the authenticated user. Returns two lists: `direct` (personal) and `broadcasts` (group/audience).","tags":["Notification"],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"hasError":{"type":"boolean","default":false},"statusCode":{"type":"integer","default":200},"message":{"type":"object","properties":{"general":{"type":"array","items":{"type":"string"}}}},"response":{"$ref":"#/components/schemas/NotificationListResponse"}},"required":["hasError","statusCode","message","response"]}}},"description":""}}}}}}
```


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.mulearn.org/api-reference/notification.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.