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

# Notifications

In-app announcements

## Send Notification

> Sends an in-app announcement to members of your organization. It is delivered over the websocket connection and appears in the recipients' notification list; no email is sent. Every recipient must already be a member of your organization, otherwise the whole call fails with 400 and names the addresses that are not. Emails are lowercased and de-duplicated before sending, and \`title\` is rendered in bold above the message. Matching is case sensitive against the stored address, so a member whose email is stored with capitals is reported as a non-member. Any field outside \`receivers\`, \`message\` and \`title\` is rejected with 400.

```json
{"openapi":"3.0.3","info":{"title":"Ango Hub API v2","version":"2.0.0"},"tags":[{"name":"Notifications","description":"In-app announcements"}],"servers":[{"url":"https://imeritapi.ango.ai/v2","description":"EU Production Server"},{"url":"https://us-api.ango.ai/v2","description":"US Production Server"},{"url":"https://in-api.ango.ai/v2","description":"India Production Server"},{"url":"https://testapi.ango.ai/v2","description":"Test Server"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey","description":"API key for authentication. Format - apikey YOUR_API_KEY"}},"schemas":{"SendNotificationRequest":{"type":"object","required":["receivers","message"],"properties":{"receivers":{"type":"array","minItems":1,"maxItems":100,"description":"Emails of organization members. Lowercased and de-duplicated before sending.","items":{"type":"string","format":"email"}},"message":{"type":"string","maxLength":1000},"title":{"type":"string","maxLength":200,"description":"Rendered in bold above the message"}}},"NotificationResponse":{"type":"object","properties":{"status":{"type":"string"},"data":{"type":"object","properties":{"notification":{"type":"object","properties":{"_id":{"type":"string"},"id":{"type":"string"},"sender":{"type":"string"},"receivers":{"type":"array","items":{"type":"string"}},"title":{"type":"string"},"actionType":{"type":"string"},"description":{"type":"string","description":"Title and message, HTML escaped and joined by a line break"},"parentType":{"type":"string"},"createdAt":{"type":"string","format":"date-time"}}}}}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string","enum":["fail","error"]},"message":{"type":"string"}}}},"responses":{"BadRequestError":{"description":"Bad request - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UnauthorizedError":{"description":"Unauthorized - invalid or missing API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ForbiddenError":{"description":"Forbidden - insufficient permissions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"paths":{"/notifications":{"post":{"tags":["Notifications"],"summary":"Send Notification","description":"Sends an in-app announcement to members of your organization. It is delivered over the websocket connection and appears in the recipients' notification list; no email is sent. Every recipient must already be a member of your organization, otherwise the whole call fails with 400 and names the addresses that are not. Emails are lowercased and de-duplicated before sending, and `title` is rendered in bold above the message. Matching is case sensitive against the stored address, so a member whose email is stored with capitals is reported as a non-member. Any field outside `receivers`, `message` and `title` is rejected with 400.","operationId":"sendNotification","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendNotificationRequest"}}}},"responses":{"201":{"description":"Notification sent","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationResponse"}}}},"400":{"$ref":"#/components/responses/BadRequestError"},"401":{"$ref":"#/components/responses/UnauthorizedError"},"403":{"$ref":"#/components/responses/ForbiddenError"}}}}}}
```


---

# 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.imerit.net/api/docs/notifications.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.