Skip to content
API Reference/
/
Reset template to default

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

Update notification template

Request

Update notification template. Creates platform-specific copy on first edit.

Security
PlatformApiKeyAuthentication
Path
notification_typestringrequired
platform_keystringrequired
Body
namestring or null<= 255 characters

A friendly name for the notification template.

descriptionstring

Admin-friendly description of what this notification does, when it triggers, and what data it needs

message_titlestring or null<= 255 characters

The title for the notification message.

message_bodystring

The full notification message body.

short_message_bodystring

A short version of the notification message body.

email_subjectstring or null<= 255 characters

Email subject line (supports Django template syntax)

email_from_addressstring or null<= 255 characters

Sender email address (default: IBL noreply@ibl.ai)

email_html_templatestring or null

Full HTML template for email body

spa_idsArray of integerswrite-only
channel_idsArray of integerswrite-only
metadataany
proactive_prompt_messagestring or null

Default prompt message for AI mentor notifications

periodic_learner_scopestringwrite-only
Enum"ACTIVE_LEARNERS""ALL_LEARNERS"
periodic_report_period_daysinteger[ 1 .. 365 ]write-only
periodic_frequencystringwrite-only
Enum"DAILY""WEEKLY""MONTHLY""CUSTOM"
periodic_custom_interval_daysinteger[ 1 .. 365 ]write-only
periodic_execution_timestringwrite-only
periodic_timezonestringwrite-only
periodic_mentorsArray of objectswrite-only

List of mentor configurations: [{"unique_id": "uuid", "prompt": "..."}]

curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/platforms/{platform_key}/templates/{notification_type}/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "DEFAULT_TEMPLATE",
    "name": "string",
    "description": "string",
    "message_title": "string",
    "message_body": "string",
    "short_message_body": "string",
    "email_subject": "string",
    "email_from_address": "string",
    "email_html_template": "string",
    "spa_ids": [
      0
    ],
    "channel_ids": [
      0
    ],
    "metadata": null,
    "proactive_prompt_message": "string",
    "periodic_learner_scope": "ACTIVE_LEARNERS",
    "periodic_report_period_days": 1,
    "periodic_frequency": "DAILY",
    "periodic_custom_interval_days": 1,
    "periodic_execution_time": "string",
    "periodic_timezone": "string",
    "periodic_mentors": [
      {
        "property1": null,
        "property2": null
      }
    ]
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired

Unique identifier for this notification template.

type(Type2a5Enum (string or null)) or (NullEnum (any or null))read-onlyrequired
One of:

Select the type of notification from the available options.

  • DEFAULT_TEMPLATE - Default Template
  • APP_REGISTRATION - App Registration
  • USER_NOTIF_USER_REGISTRATION - User Notif User Registration
  • USER_NOTIF_COURSE_ENROLLMENT - User Notif Course Enrollment
  • ADMIN_NOTIF_COURSE_ENROLLMENT - Admin Notif Course Enrollment
  • USER_NOTIF_USER_INACTIVITY - User Notif User Inactivity
  • USER_NOTIF_COURSE_COMPLETION - User Notif Course Completion
  • USER_NOTIF_CREDENTIALS - User Notif Credentials
  • CUSTOM_NOTIFICATION - Custom Notification
  • PLATFORM_INVITATION - Platform Invitation
  • PROGRAM_INVITATION - Program Invitation
  • COURSE_INVITATION - Course Invitation
  • USER_NOTIF_LEARNER_PROGRESS - User Notif Learner Progress
  • PROACTIVE_LEARNER_NOTIFICATION - Proactive Learner Notification
  • ROLE_CHANGE - Role Change
  • COURSE_LICENSE_ASSIGNMENT - Course License Assignment
  • COURSE_LICENSE_GROUP_ASSIGNMENT - Course License Group Assignment
  • PROGRAM_LICENSE_ASSIGNMENT - Program License Assignment
  • PROGRAM_LICENSE_GROUP_ASSIGNMENT - Program License Group Assignment
  • USER_LICENSE_ASSIGNMENT - User License Assignment
  • USER_LICENSE_GROUP_ASSIGNMENT - User License Group Assignment
string or null(Type2a5Enum)read-only
Enum"DEFAULT_TEMPLATE""APP_REGISTRATION""USER_NOTIF_USER_REGISTRATION""USER_NOTIF_COURSE_ENROLLMENT""ADMIN_NOTIF_COURSE_ENROLLMENT""USER_NOTIF_USER_INACTIVITY""USER_NOTIF_COURSE_COMPLETION""USER_NOTIF_CREDENTIALS""CUSTOM_NOTIFICATION""PLATFORM_INVITATION"
namestring or null<= 255 characters

A friendly name for the notification template.

descriptionstring

Admin-friendly description of what this notification does, when it triggers, and what data it needs

message_titlestring or null<= 255 characters

The title for the notification message.

message_bodystring

The full notification message body.

short_message_bodystring

A short version of the notification message body.

email_subjectstring or null<= 255 characters

Email subject line (supports Django template syntax)

email_from_addressstring or null<= 255 characters

Sender email address (default: IBL noreply@ibl.ai)

email_html_templatestring or null

Full HTML template for email body

spas_detailArray of objects(Spa)read-onlyrequired
spas_detail[].​idintegerread-onlyrequired
spas_detail[].​namestring<= 100 charactersrequired

Unique identifier for the SPA (e.g., 'skills', 'mentor', 'admin', 'mobile')

spas_detail[].​descriptionstring<= 255 characters

Human-friendly description of this SPA

allowed_channels_detailArray of objects(ConsumerChannel)read-onlyrequired
allowed_channels_detail[].​idintegerread-onlyrequired
allowed_channels_detail[].​namestring(Channel name)<= 255 characters
is_inheritedbooleanread-onlyrequired
is_enabledbooleanread-onlyrequired
source_platformstringread-onlyrequired
metadataany
available_contextstringread-onlyrequired
proactive_prompt_messagestring or null

Default prompt message for AI mentor notifications

periodic_configstringread-onlyrequired
created_atstring(date-time)read-onlyrequired

Timestamp when this template was created

updated_atstring(date-time)read-onlyrequired

Timestamp when this template was last updated

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "DEFAULT_TEMPLATE",
  "name": "string",
  "description": "string",
  "message_title": "string",
  "message_body": "string",
  "short_message_body": "string",
  "email_subject": "string",
  "email_from_address": "string",
  "email_html_template": "string",
  "spas_detail": [
    { … }
  ],
  "allowed_channels_detail": [
    { … }
  ],
  "is_inherited": true,
  "is_enabled": true,
  "source_platform": "string",
  "metadata": null,
  "available_context": "string",
  "proactive_prompt_message": "string",
  "periodic_config": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

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

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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