Brein API

Notification Preferences

Get notification preferences for current user

GET

/api/v1/notification-preferences

Retrieve notification preferences for the currently authenticated user

Get notification preferences for current user › Responses

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
enableNotificationsboolean · required
Global enable notifications switch
pushNotificationsboolean · required
Enable push notifications
emailNotificationsboolean · required
Enable email notifications
emailWeeklySummaryboolean · required
Weekly summary via email
emailNewActivityboolean · required
Activity via email (new event, task or invite)
notifyNewTaskboolean · required
Receive new task notifications
notifyTaskExpiringboolean · required
Receive task about to expire notifications
notifyTaskReminderboolean · required
Receive task reminder notifications
notifyTaskCompletedboolean · required
Receive task completed notifications
notifyNewEventboolean · required
Receive new event notifications
notifyBeforeEventboolean · required
Receive reminder before event notifications
notifySchoolPostboolean · required
Receive notifications for school posts
notifyClassroomPostboolean · required
Receive notifications for classroom posts
eventReminderTimingstring · enum · required
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

GET /api/v1/notification-preferences

curl --request GET \
  --url /api/v1/notification-preferences

shell

Show example in

Example Responses

No example

json

application/json

Create or update notification preferences

POST

/api/v1/notification-preferences

Create or update notification preferences for the current user

Create or update notification preferences › Request Body

enableNotificationsboolean · required
Global enable notifications switch
pushNotificationsboolean · required
Enable push notifications
emailNotificationsboolean · required
Enable email notifications
emailWeeklySummaryboolean · required
Weekly summary via email
emailNewActivityboolean · required
Activity via email (new event, task or invite)
notifyNewTaskboolean · required
Receive new task notifications
notifyTaskExpiringboolean · required
Receive task about to expire notifications
notifyTaskReminderboolean · required
Receive task reminder notifications
notifyTaskCompletedboolean · required
Receive task completed notifications
notifyNewEventboolean · required
Receive new event notifications
notifyBeforeEventboolean · required
Receive reminder before event notifications
notifySchoolPostboolean · required
Receive notifications for school posts
notifyClassroomPostboolean · required
Receive notifications for classroom posts
eventReminderTimingstring · enum · required
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

Create or update notification preferences › Responses

Notification preferences created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
enableNotificationsboolean · required
Global enable notifications switch
pushNotificationsboolean · required
Enable push notifications
emailNotificationsboolean · required
Enable email notifications
emailWeeklySummaryboolean · required
Weekly summary via email
emailNewActivityboolean · required
Activity via email (new event, task or invite)
notifyNewTaskboolean · required
Receive new task notifications
notifyTaskExpiringboolean · required
Receive task about to expire notifications
notifyTaskReminderboolean · required
Receive task reminder notifications
notifyTaskCompletedboolean · required
Receive task completed notifications
notifyNewEventboolean · required
Receive new event notifications
notifyBeforeEventboolean · required
Receive reminder before event notifications
notifySchoolPostboolean · required
Receive notifications for school posts
notifyClassroomPostboolean · required
Receive notifications for classroom posts
eventReminderTimingstring · enum · required
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

POST /api/v1/notification-preferences

curl --request POST \
  --url /api/v1/notification-preferences \
  --header 'Content-Type: application/json' \
  --data '
{
  "enableNotifications": true,
  "pushNotifications": true,
  "emailNotifications": true,
  "emailWeeklySummary": true,
  "emailNewActivity": true,
  "notifyNewTask": true,
  "notifyTaskExpiring": true,
  "notifyTaskReminder": true,
  "notifyTaskCompleted": true,
  "notifyNewEvent": true,
  "notifyBeforeEvent": true,
  "notifySchoolPost": true,
  "notifyClassroomPost": true,
  "eventReminderTiming": "SAME_DAY"
}
'

shell

Show example in

Request Body Example

{
  "enableNotifications": true,
  "pushNotifications": true,
  "emailNotifications": true,
  "emailWeeklySummary": true,
  "emailNewActivity": true,
  "notifyNewTask": true,
  "notifyTaskExpiring": true,
  "notifyTaskReminder": true,
  "notifyTaskCompleted": true,
  "notifyNewEvent": true,
  "notifyBeforeEvent": true,
  "notifySchoolPost": true,
  "notifyClassroomPost": true,
  "eventReminderTiming": "SAME_DAY"
}

json

Example Responses

No example

json

application/json

Get notification preferences by ID

GET

/api/v1/notification-preferences/{id}

Retrieve a specific notification preferences by its ID

Get notification preferences by ID › path Parameters

idnumber · min: 1 · required
Id

Get notification preferences by ID › Responses

Notification preferences detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
enableNotificationsboolean · required
Global enable notifications switch
pushNotificationsboolean · required
Enable push notifications
emailNotificationsboolean · required
Enable email notifications
emailWeeklySummaryboolean · required
Weekly summary via email
emailNewActivityboolean · required
Activity via email (new event, task or invite)
notifyNewTaskboolean · required
Receive new task notifications
notifyTaskExpiringboolean · required
Receive task about to expire notifications
notifyTaskReminderboolean · required
Receive task reminder notifications
notifyTaskCompletedboolean · required
Receive task completed notifications
notifyNewEventboolean · required
Receive new event notifications
notifyBeforeEventboolean · required
Receive reminder before event notifications
notifySchoolPostboolean · required
Receive notifications for school posts
notifyClassroomPostboolean · required
Receive notifications for classroom posts
eventReminderTimingstring · enum · required
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

GET /api/v1/notification-preferences/{id}

curl --request GET \
  --url /api/v1/notification-preferences/:id

shell

Show example in

Example Responses

No example

json

application/json

Update notification preferences

PUT

/api/v1/notification-preferences/{id}

Update an existing notification preferences by its ID

Update notification preferences › path Parameters

idnumber · min: 1 · required
Id

Update notification preferences › Request Body

enableNotificationsboolean
Global enable notifications switch
pushNotificationsboolean
Enable push notifications
emailNotificationsboolean
Enable email notifications
emailWeeklySummaryboolean
Weekly summary via email
emailNewActivityboolean
Activity via email (new event, task or invite)
notifyNewTaskboolean
Receive new task notifications
notifyTaskExpiringboolean
Receive task about to expire notifications
notifyTaskReminderboolean
Receive task reminder notifications
notifyTaskCompletedboolean
Receive task completed notifications
notifyNewEventboolean
Receive new event notifications
notifyBeforeEventboolean
Receive reminder before event notifications
notifySchoolPostboolean
Receive notifications for school posts
notifyClassroomPostboolean
Receive notifications for classroom posts
eventReminderTimingstring · enum
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

Update notification preferences › Responses

Notification preferences updated

No data returned

PUT /api/v1/notification-preferences/{id}

curl --request PUT \
  --url /api/v1/notification-preferences/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "enableNotifications": true,
  "pushNotifications": true,
  "emailNotifications": true,
  "emailWeeklySummary": true,
  "emailNewActivity": true,
  "notifyNewTask": true,
  "notifyTaskExpiring": true,
  "notifyTaskReminder": true,
  "notifyTaskCompleted": true,
  "notifyNewEvent": true,
  "notifyBeforeEvent": true,
  "notifySchoolPost": true,
  "notifyClassroomPost": true,
  "eventReminderTiming": "SAME_DAY"
}
'

shell

Show example in

Request Body Example

{
  "enableNotifications": true,
  "pushNotifications": true,
  "emailNotifications": true,
  "emailWeeklySummary": true,
  "emailNewActivity": true,
  "notifyNewTask": true,
  "notifyTaskExpiring": true,
  "notifyTaskReminder": true,
  "notifyTaskCompleted": true,
  "notifyNewEvent": true,
  "notifyBeforeEvent": true,
  "notifySchoolPost": true,
  "notifyClassroomPost": true,
  "eventReminderTiming": "SAME_DAY"
}

json

Example Responses

No example

plain

Delete notification preferences

DELETE

/api/v1/notification-preferences/{id}

Delete notification preferences by its ID

Delete notification preferences › path Parameters

idnumber · min: 1 · required
Id

Delete notification preferences › Responses

Notification preferences deleted

No data returned

DELETE /api/v1/notification-preferences/{id}

curl --request DELETE \
  --url /api/v1/notification-preferences/:id

shell

Show example in

Example Responses

No example

plain

Notification Teacher

Brein API

Notification Preferences

Get notification preferences for current user

GET

/api/v1/notification-preferences

Retrieve notification preferences for the currently authenticated user

Get notification preferences for current user › Responses

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
enableNotificationsboolean · required
Global enable notifications switch
pushNotificationsboolean · required
Enable push notifications
emailNotificationsboolean · required
Enable email notifications
emailWeeklySummaryboolean · required
Weekly summary via email
emailNewActivityboolean · required
Activity via email (new event, task or invite)
notifyNewTaskboolean · required
Receive new task notifications
notifyTaskExpiringboolean · required
Receive task about to expire notifications
notifyTaskReminderboolean · required
Receive task reminder notifications
notifyTaskCompletedboolean · required
Receive task completed notifications
notifyNewEventboolean · required
Receive new event notifications
notifyBeforeEventboolean · required
Receive reminder before event notifications
notifySchoolPostboolean · required
Receive notifications for school posts
notifyClassroomPostboolean · required
Receive notifications for classroom posts
eventReminderTimingstring · enum · required
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

GET /api/v1/notification-preferences

curl --request GET \
  --url /api/v1/notification-preferences

shell

Show example in

Example Responses

No example

json

application/json

Create or update notification preferences

POST

/api/v1/notification-preferences

Create or update notification preferences for the current user

Create or update notification preferences › Request Body

enableNotificationsboolean · required
Global enable notifications switch
pushNotificationsboolean · required
Enable push notifications
emailNotificationsboolean · required
Enable email notifications
emailWeeklySummaryboolean · required
Weekly summary via email
emailNewActivityboolean · required
Activity via email (new event, task or invite)
notifyNewTaskboolean · required
Receive new task notifications
notifyTaskExpiringboolean · required
Receive task about to expire notifications
notifyTaskReminderboolean · required
Receive task reminder notifications
notifyTaskCompletedboolean · required
Receive task completed notifications
notifyNewEventboolean · required
Receive new event notifications
notifyBeforeEventboolean · required
Receive reminder before event notifications
notifySchoolPostboolean · required
Receive notifications for school posts
notifyClassroomPostboolean · required
Receive notifications for classroom posts
eventReminderTimingstring · enum · required
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

Create or update notification preferences › Responses

Notification preferences created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
enableNotificationsboolean · required
Global enable notifications switch
pushNotificationsboolean · required
Enable push notifications
emailNotificationsboolean · required
Enable email notifications
emailWeeklySummaryboolean · required
Weekly summary via email
emailNewActivityboolean · required
Activity via email (new event, task or invite)
notifyNewTaskboolean · required
Receive new task notifications
notifyTaskExpiringboolean · required
Receive task about to expire notifications
notifyTaskReminderboolean · required
Receive task reminder notifications
notifyTaskCompletedboolean · required
Receive task completed notifications
notifyNewEventboolean · required
Receive new event notifications
notifyBeforeEventboolean · required
Receive reminder before event notifications
notifySchoolPostboolean · required
Receive notifications for school posts
notifyClassroomPostboolean · required
Receive notifications for classroom posts
eventReminderTimingstring · enum · required
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

POST /api/v1/notification-preferences

curl --request POST \
  --url /api/v1/notification-preferences \
  --header 'Content-Type: application/json' \
  --data '
{
  "enableNotifications": true,
  "pushNotifications": true,
  "emailNotifications": true,
  "emailWeeklySummary": true,
  "emailNewActivity": true,
  "notifyNewTask": true,
  "notifyTaskExpiring": true,
  "notifyTaskReminder": true,
  "notifyTaskCompleted": true,
  "notifyNewEvent": true,
  "notifyBeforeEvent": true,
  "notifySchoolPost": true,
  "notifyClassroomPost": true,
  "eventReminderTiming": "SAME_DAY"
}
'

shell

Show example in

Request Body Example

{
  "enableNotifications": true,
  "pushNotifications": true,
  "emailNotifications": true,
  "emailWeeklySummary": true,
  "emailNewActivity": true,
  "notifyNewTask": true,
  "notifyTaskExpiring": true,
  "notifyTaskReminder": true,
  "notifyTaskCompleted": true,
  "notifyNewEvent": true,
  "notifyBeforeEvent": true,
  "notifySchoolPost": true,
  "notifyClassroomPost": true,
  "eventReminderTiming": "SAME_DAY"
}

json

Example Responses

No example

json

application/json

Get notification preferences by ID

GET

/api/v1/notification-preferences/{id}

Retrieve a specific notification preferences by its ID

Get notification preferences by ID › path Parameters

idnumber · min: 1 · required
Id

Get notification preferences by ID › Responses

Notification preferences detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
enableNotificationsboolean · required
Global enable notifications switch
pushNotificationsboolean · required
Enable push notifications
emailNotificationsboolean · required
Enable email notifications
emailWeeklySummaryboolean · required
Weekly summary via email
emailNewActivityboolean · required
Activity via email (new event, task or invite)
notifyNewTaskboolean · required
Receive new task notifications
notifyTaskExpiringboolean · required
Receive task about to expire notifications
notifyTaskReminderboolean · required
Receive task reminder notifications
notifyTaskCompletedboolean · required
Receive task completed notifications
notifyNewEventboolean · required
Receive new event notifications
notifyBeforeEventboolean · required
Receive reminder before event notifications
notifySchoolPostboolean · required
Receive notifications for school posts
notifyClassroomPostboolean · required
Receive notifications for classroom posts
eventReminderTimingstring · enum · required
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

GET /api/v1/notification-preferences/{id}

curl --request GET \
  --url /api/v1/notification-preferences/:id

shell

Show example in

Example Responses

No example

json

application/json

Update notification preferences

PUT

/api/v1/notification-preferences/{id}

Update an existing notification preferences by its ID

Update notification preferences › path Parameters

idnumber · min: 1 · required
Id

Update notification preferences › Request Body

enableNotificationsboolean
Global enable notifications switch
pushNotificationsboolean
Enable push notifications
emailNotificationsboolean
Enable email notifications
emailWeeklySummaryboolean
Weekly summary via email
emailNewActivityboolean
Activity via email (new event, task or invite)
notifyNewTaskboolean
Receive new task notifications
notifyTaskExpiringboolean
Receive task about to expire notifications
notifyTaskReminderboolean
Receive task reminder notifications
notifyTaskCompletedboolean
Receive task completed notifications
notifyNewEventboolean
Receive new event notifications
notifyBeforeEventboolean
Receive reminder before event notifications
notifySchoolPostboolean
Receive notifications for school posts
notifyClassroomPostboolean
Receive notifications for classroom posts
eventReminderTimingstring · enum
Event reminder timing
Enum values:
SAME_DAY
ONE_DAY_BEFORE
ONE_WEEK_BEFORE
Default: ONE_DAY_BEFORE

Update notification preferences › Responses

Notification preferences updated

No data returned

PUT /api/v1/notification-preferences/{id}

curl --request PUT \
  --url /api/v1/notification-preferences/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "enableNotifications": true,
  "pushNotifications": true,
  "emailNotifications": true,
  "emailWeeklySummary": true,
  "emailNewActivity": true,
  "notifyNewTask": true,
  "notifyTaskExpiring": true,
  "notifyTaskReminder": true,
  "notifyTaskCompleted": true,
  "notifyNewEvent": true,
  "notifyBeforeEvent": true,
  "notifySchoolPost": true,
  "notifyClassroomPost": true,
  "eventReminderTiming": "SAME_DAY"
}
'

shell

Show example in

Request Body Example

{
  "enableNotifications": true,
  "pushNotifications": true,
  "emailNotifications": true,
  "emailWeeklySummary": true,
  "emailNewActivity": true,
  "notifyNewTask": true,
  "notifyTaskExpiring": true,
  "notifyTaskReminder": true,
  "notifyTaskCompleted": true,
  "notifyNewEvent": true,
  "notifyBeforeEvent": true,
  "notifySchoolPost": true,
  "notifyClassroomPost": true,
  "eventReminderTiming": "SAME_DAY"
}

json

Example Responses

No example

plain

Delete notification preferences

DELETE

/api/v1/notification-preferences/{id}

Delete notification preferences by its ID

Delete notification preferences › path Parameters

idnumber · min: 1 · required
Id

Delete notification preferences › Responses

Notification preferences deleted

No data returned

DELETE /api/v1/notification-preferences/{id}

curl --request DELETE \
  --url /api/v1/notification-preferences/:id

shell

Show example in

Example Responses

No example

plain

Notification Teacher