Notification Accessibility Config - API Contract

GET /api/v1/notification-accessibility/api/v1/notification-accessibility

List all notification channel/category configurations

Public

Response Example

{
  "data": [
    {
      "config_id": "cfg-301",
      "platform": "android",
      "category": "deadline_reminder",
      "channel_id": "deadline_channel",
      "channel_name": "Deadline Reminders",
      "importance": "high",
      "sound": "default",
      "vibrate": true
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 6
  }
}

GET /api/v1/notification-accessibility/api/v1/notification-accessibility/:id

Get a specific notification channel config

Public

Response Example

{
  "config_id": "cfg-301",
  "platform": "android",
  "category": "deadline_reminder",
  "channel_id": "deadline_channel",
  "channel_name": "Deadline Reminders",
  "importance": "high",
  "sound": "default",
  "vibrate": true,
  "led_color": "#FF0000"
}

POST /api/v1/notification-accessibility/api/v1/notification-accessibility

Create a new notification channel/category config

Public

Request Example

{
  "platform": "android",
  "category": "assignment_posted",
  "channel_id": "assignment_channel",
  "channel_name": "Assignment Updates",
  "importance": "default",
  "sound": "default",
  "vibrate": true
}

Response Example

{
  "config_id": "cfg-310",
  "platform": "android",
  "category": "assignment_posted",
  "channel_id": "assignment_channel",
  "channel_name": "Assignment Updates",
  "importance": "default",
  "sound": "default",
  "vibrate": true
}

PUT /api/v1/notification-accessibility/api/v1/notification-accessibility/:id

Update a notification channel configuration

Public

Request Example

{
  "importance": "high",
  "sound": "alert_tone",
  "vibrate": false
}

Response Example

{
  "config_id": "cfg-301",
  "importance": "high",
  "sound": "alert_tone",
  "vibrate": false
}

DELETE /api/v1/notification-accessibility/api/v1/notification-accessibility/:id

Delete a notification channel configuration

Public

Response Example

{
  "deleted": true,
  "config_id": "cfg-301"
}

GET /api/v1/notification-accessibility/api/v1/notification-accessibility/category/:category

Get channel/options config for a specific notification category

Public

Response Example

{
  "category": "deadline_reminder",
  "android": {
    "channel_id": "deadline_channel",
    "channel_name": "Deadline Reminders",
    "importance": "high",
    "sound": "default",
    "vibrate": true,
    "led_color": "#FF0000"
  },
  "ios": {
    "presentation_options": [
      "alert",
      "badge",
      "sound"
    ],
    "badge_count": 1,
    "thread_identifier": "deadline_thread"
  }
}

Additional Metadata

{
  "contract_summary": {
    "total_contracts": 410,
    "total_endpoints": 2416,
    "api_styles_used": [
      "rest"
    ]
  },
  "generated_at": "2026-03-26T06:55:53.316Z"
}