send_notification

imerit_ango.sdk.SDK.

send_notification(receivers, message, title=None)

Send an in-app announcement to specific members of your organization.

The API key must belong to an organization administrator. Recipients must be members of the organization associated with the API key.

This function is available in imerit-ango 1.4.7 and later.

Parameters

• receivers: List[str]

  • Email addresses of the members who should receive the notification.

  • You can include up to 100 unique addresses.

  • You cannot send a notification only to yourself.

• message: str

  • The notification message. Maximum length: 1000 characters.

• title: str, Optional, Default None

  • A title for the notification. Maximum length: 200 characters.

Returns:

• output: dict

  • A dictionary containing a status field and the created notification in data.notification.

How to verify in Ango Hub?

After successfully sending the notification, recipients can open the notification panel from the bell icon in the top-right corner of Ango Hub. The notification shows the sender, optional title, and message.

Example

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')

ango_sdk = SDK(api_key)

sdk_response = ango_sdk.send_notification(
    receivers=["[e-mail]", "[e-mail]"],
    title="Project update",
    message="The new task batch is ready for labeling."
)

curl

curl -X POST "https://imeritapi.ango.ai/v2/notifications" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY" \
  -d '{
    "receivers": [
      "[e-mail]",
      "[e-mail]"
    ],
    "title": "Project update",
    "message": "The new task batch is ready for labeling."
  }'

See also

Notifications, get_organization_members