For the complete documentation index, see llms.txt. This page is also available as Markdown.

Notifications

In-app announcements

Send Notification

post
/notifications

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.

Authorizations
apikeystringRequired

API key for authentication. Format - apikey YOUR_API_KEY

Body
receiversstring · email[] · min: 1 · max: 100Required

Emails of organization members. Lowercased and de-duplicated before sending.

messagestring · max: 1000Required
titlestring · max: 200Optional

Rendered in bold above the message

Responses
201

Notification sent

application/json
statusstringOptionalExample: success
post/notifications
curl -X POST "https://imeritapi.ango.ai/v2/notifications" \
  -H "apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "receivers": ["user1@example.com", "user2@example.com"],
    "title": "Scheduled maintenance",
    "message": "The platform will be read-only on Saturday between 09:00 and 11:00 UTC."
  }'
{
  "status": "success",
  "data": {
    "notification": {
      "_id": "text",
      "id": "text",
      "sender": "text",
      "receivers": [
        "text"
      ],
      "title": "ANNOUNCEMENT",
      "actionType": "ANNOUNCEMENT",
      "description": "text",
      "parentType": "NONE",
      "createdAt": "2026-01-01T00:00:00.000Z"
    }
  }
}

Last updated