Skip to content

ulams notifications-bulk

Generated from front/cli (ulams schema)

Get a listing of the bulk notifications.

Kind: read (idempotent). Stability: stable. MCP tool: notifications_bulk_list. Scopes: settings:read.

Endpoints: GET /api/admin/bulk-notifications.

Flag Type Required Description
--page number Pagination Page Number
--per-page number Pagination Per Page
--channel string Bulk notification channel [Ulams\BulkNotifications\Channels\PushNotificationChannel]
Terminal window
# Get a listing of the bulk notifications
ulams notifications-bulk list --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"page": {
"type": "number",
"description": "Pagination Page Number"
},
"per_page": {
"type": "number",
"description": "Pagination Per Page"
},
"channel": {
"type": "string",
"description": "Bulk notification channel [Ulams\\BulkNotifications\\Channels\\PushNotificationChannel]"
}
},
"additionalProperties": {}
}

Store a newly notification.

Kind: write. Stability: stable. MCP tool: notifications_bulk_send. Scopes: settings:write.

Endpoints: POST /api/admin/bulk-notifications/send.

Flag Type Required Description
--channel string yes channel
--sections array yes sections
--user-ids array yes user_ids
Terminal window
# Store a newly notification
ulams notifications-bulk send --channel text --sections text --user-ids text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "channel"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"image_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"title": {
"type": "string"
}
},
"additionalProperties": {}
},
"description": "sections"
},
"user_ids": {
"type": "array",
"items": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"description": "user_ids"
}
},
"required": [
"channel",
"sections",
"user_ids"
],
"additionalProperties": {}
}

Store a newly notification.

Kind: write. Stability: stable. MCP tool: notifications_bulk_send_multicast. Scopes: settings:write.

Endpoints: POST /api/admin/bulk-notifications/send/multicast.

Flag Type Required Description
--channel string yes channel
--sections array yes sections
Terminal window
# Store a newly notification
ulams notifications-bulk send-multicast --channel text --sections text --json
Input JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"channel": {
"type": "string",
"description": "channel"
},
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"body": {
"type": "string"
},
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"image_url": {
"type": "string"
},
"redirect_url": {
"type": "string"
},
"title": {
"type": "string"
}
},
"additionalProperties": {}
},
"description": "sections"
}
},
"required": [
"channel",
"sections"
],
"additionalProperties": {}
}