Skip to content
API Reference/
/
Test SMTP credentials for...

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

Validate notification source

Request

Validate a single notification source (email, username, platform, csv)

Security
PlatformApiKeyAuthentication
Path
platform_keystringrequired
Body
required
typestring(NotificationSourceTypeEnum)required
  • email - email
  • username - username
  • platform - platform
  • csv - csv
  • department - department
  • pathway - pathway
  • program - program
Enum"email""username""platform""csv""department""pathway""program"
dataany or nullrequired
curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/orgs/{platform_key}/notification-builder/validate_source/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "type": "email",
    "data": null
  }'

Responses

Bodyapplication/json
statusstringrequired
valid_countintegerrequired
invalid_entriesArray of stringsrequired
sample_recipientsArray of objects(Recipient)required
sample_recipients[].​usernamestringrequired
sample_recipients[].​emailstring(email)required
sample_recipients[].​statusstring
Default "pending"
Response
application/json
{
  "status": "string",
  "valid_count": 0,
  "invalid_entries": [
    "string"
  ],
  "sample_recipients": [
    { … }
  ]
}

Test SMTP credentials for a platform

Request

Test SMTP credentials by sending a test email to the specified address

Security
PlatformApiKeyAuthentication
Path
platform_keystringrequired
Body
required
smtp_hoststring<= 255 charactersrequired

SMTP server hostname

smtp_portinteger[ 1 .. 65535 ]required

SMTP server port

smtp_usernamestring<= 255 charactersrequired

SMTP username

smtp_passwordstring<= 255 characterswrite-onlyrequired

SMTP password

use_tlsboolean

Use TLS encryption

Default true
use_sslboolean

Use SSL encryption

Default false
test_emailstring(email)required

Email address to send test email to

from_emailstring(email)

From email address (optional)

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/platforms/{platform_key}/config/test-smtp/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "smtp_host": "string",
    "smtp_port": 1,
    "smtp_username": "string",
    "smtp_password": "string",
    "use_tls": true,
    "use_ssl": false,
    "test_email": "user@example.com",
    "from_email": "user@example.com"
  }'

Responses

Bodyapplication/json
statusstringrequired
messagestringrequired
successbooleanrequired
Response
application/json
{
  "status": "string",
  "message": "string",
  "success": true
}

List notification templates

Request

Get all notification templates for the platform. Includes both platform-specific and inherited templates from main.

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

Responses

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Unique identifier for this notification template.

type(Type2a5Enum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
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)
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

is_inheritedbooleanread-onlyrequired
source_platformstringread-onlyrequired
is_enabledbooleanread-onlyrequired
can_customizebooleanread-onlyrequired
is_custombooleanread-onlyrequired
Default false
message_titlestring or null<= 255 characters

The title for the notification message.

email_subjectstring or null<= 255 characters

Email subject line (supports Django template syntax)

spasstringread-onlyrequired
allowed_channelsstringread-onlyrequired
available_contextstringread-onlyrequired
]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "DEFAULT_TEMPLATE",
    "name": "string",
    "description": "string",
    "is_inherited": true,
    "source_platform": "string",
    "is_enabled": true,
    "can_customize": true,
    "is_custom": false,
    "message_title": "string",
    "email_subject": "string",
    "spas": "string",
    "allowed_channels": "string",
    "available_context": "string"
  }
]

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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