Skip to content
API Reference/
/
notification_v1_orgs_user...

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

notification_v1_orgs_users_notifications_bulk_update_partial_update

Request

Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
usernamestring
statusNotificationStatusEnum (string) or BlankEnum (any)(Message status)
One of:
  • READ - Read
  • UNREAD - Unread
  • CANCELLED - Cancelled
string(NotificationStatusEnum)
Enum"READ""UNREAD""CANCELLED"
contextany or null
created_atstring(date-time)
curl -i -X PATCH \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/orgs/{org}/users/{user_id}/notifications/bulk-update/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string",
    "status": "READ",
    "context": null,
    "created_at": "2019-08-24T14:15:22Z"
  }'

Responses

Bodyapplication/json
idstring(uuid)read-onlyrequired
usernamestringrequired
titlestringread-onlyrequired
bodystringread-onlyrequired
statusNotificationStatusEnum (string) or BlankEnum (any)(Message status)
One of:
  • READ - Read
  • UNREAD - Unread
  • CANCELLED - Cancelled
string(NotificationStatusEnum)
Enum"READ""UNREAD""CANCELLED"
channelstring or nullread-onlyrequired
contextany or null
short_messagestringread-onlyrequired
created_atstring(date-time)
updated_atstring(date-time)read-onlyrequired
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "username": "string",
  "title": "string",
  "body": "string",
  "status": "READ",
  "channel": "string",
  "context": null,
  "short_message": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

notification_v1_orgs_users_register_fcm_token_create

Request

Save a user's device token

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Body
required
idinteger
namestring or null<= 255 characters
registration_idstringrequired
device_idinteger or null

ANDROID_ID / TelephonyManager.getDeviceId() (e.g: 0x01)

activeboolean(Is active)

Inactive devices will not be sent notifications

cloud_message_typestring
Enum"FCM""GCM"
application_idstring or null<= 64 characters

Opaque application identity, should be filled in for multiple key/certificate access

curl -i -X POST \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/orgs/{org}/users/{user_id}/register-fcm-token/' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "name": "string",
    "registration_id": "string",
    "device_id": 0,
    "active": true,
    "cloud_message_type": "FCM",
    "application_id": "string"
  }'

Responses

Bodyapplication/json
idinteger
namestring or null<= 255 characters
registration_idstringrequired
device_idinteger or null

ANDROID_ID / TelephonyManager.getDeviceId() (e.g: 0x01)

activeboolean(Is active)

Inactive devices will not be sent notifications

date_createdstring or null(date-time)(Creation date)read-onlyrequired
cloud_message_typestring
Enum"FCM""GCM"
application_idstring or null<= 64 characters

Opaque application identity, should be filled in for multiple key/certificate access

Response
application/json
{
  "id": 0,
  "name": "string",
  "registration_id": "string",
  "device_id": 0,
  "active": true,
  "date_created": "2019-08-24T14:15:22Z",
  "cloud_message_type": "FCM",
  "application_id": "string"
}

notification_v1_orgs_users_register_fcm_token_destroy

Request

Save a user's device token

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
curl -i -X DELETE \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/orgs/{org}/users/{user_id}/register-fcm-token/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

No response body

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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