Skip to content

ibl-data-manager (4.84.1-ai-plus)

API for iblai

Download OpenAPI description
Languages
Servers
Mock server
https://docs.ibl.ai/_mock/apis/ibl/
https://base.manager.iblai.app/
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Send a test notification to verify template rendering and delivery. Sends to the requesting admin's email or a specified test email.

Security
PlatformApiKeyAuthentication
Path
notification_typestringrequired
platform_keystringrequired
Body
test_emailstring(email)

Email address to send test notification to. Defaults to requesting user's email.

contextany

Optional context variables for template rendering (e.g., {'course_name': 'Test Course'})

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/platforms/{platform_key}/templates/{notification_type}/test/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "test_email": "user@example.com",
    "context": null
  }'

Responses

Bodyapplication/json
successbooleanrequired

Whether the test email was sent successfully

messagestringrequired

Description of the result

recipientstring(email)required

Email address the test was sent to

Response
application/json
{ "success": true, "message": "string", "recipient": "user@example.com" }

Request

Enable or disable a notification type for the platform. This sets the NotificationPreference, not the template.

Security
PlatformApiKeyAuthentication
Path
notification_typestringrequired
platform_keystringrequired
Body
allow_notificationboolean
curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/platforms/{platform_key}/templates/{notification_type}/toggle/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "allow_notification": true
  }'

Responses

Bodyapplication/json
allow_notificationbooleanrequired
Response
application/json
{ "allow_notification": true }
Operations
Operations
Operations
Operations
Operations