Skip to content
API Reference
/
notifications
/
notification_v1_orgs_notifications_update

ibl-data-manager (3.59.0-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

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

notification_v1_orgs_notifications_retrieve

Request

Get notifications for a user

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Query
channelstringnon-empty
end_datestringnon-empty
exclude_channelstringnon-empty
start_datestringnon-empty
statusstringnon-empty
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/orgs/{org}/notifications/?channel=string&end_date=string&exclude_channel=string&start_date=string&status=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

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)
  • READ - Read
  • UNREAD - Unread
  • CANCELLED - Cancelled
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_notifications_update

Request

Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
required
usernamestringrequired
statusNotificationStatusEnum (string) or BlankEnum (any)(Message status)
One of:
  • READ - Read
  • UNREAD - Unread
  • CANCELLED - Cancelled
string(NotificationStatusEnum)
  • READ - Read
  • UNREAD - Unread
  • CANCELLED - Cancelled
Enum"READ""UNREAD""CANCELLED"
contextany or null
created_atstring(date-time)
curl -i -X PUT \
  'https://docs.ibl.ai/_mock/apis/ibl/api/notification/v1/orgs/{org}/notifications/' \
  -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)
  • READ - Read
  • UNREAD - Unread
  • CANCELLED - Cancelled
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_notifications_bulk_update_partial_update

Request

Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
Body
usernamestring
statusNotificationStatusEnum (string) or BlankEnum (any)(Message status)
One of:
  • READ - Read
  • UNREAD - Unread
  • CANCELLED - Cancelled
string(NotificationStatusEnum)
  • READ - Read
  • UNREAD - Unread
  • CANCELLED - Cancelled
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}/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)
  • READ - Read
  • UNREAD - Unread
  • CANCELLED - Cancelled
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"
}

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

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