Skip to content
API Reference/
/
Send test notification

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

API for iblai

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

ai-account

Operations

ai-analytics

Operations

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

analytics

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

custom-domains

Operations

features

Operations

media

Operations

notifications

Operations

Reset template to default

Request

Delete platform-specific template override and revert to main template. Notification preference (on/off) is preserved.

Security
PlatformApiKeyAuthentication
Path
notification_typestringrequired
platform_keystringrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/platforms/{platform_key}/templates/{notification_type}/reset/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
messagestring
deletedboolean
Response
application/json
{
  "message": "string",
  "deleted": true
}

Send test notification

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"
}

Toggle notification preference

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
}

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com