Brein API

Notification

Get notifications for current user

GET

/api/v1/notification

Retrieve a paginated list of notifications for the currently authenticated user

Get notifications for current user › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get notifications for current user › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/notification

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

shell

Show example in

Example Responses

No example

json

application/json

Get notification by ID

GET

/api/v1/notification/{id}

Retrieve a specific notification by its ID

Get notification by ID › path Parameters

idnumber · min: 1 · required
Id

Get notification by ID › Responses

Notification detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
phonestring · required
Phone
statusstring · enum · required
Notification status
Enum values:
SENT
FAILED
templatestring · required
Template (whatsapp | email)
parametersobject[] · required
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null · required
Dynamic parameters
originstring · enum · required
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring · required
Title
payloadstring · required
Payload
notificationTypestring · enum · required
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean · required
Read

stackstring
Stack error

GET /api/v1/notification/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a notification

PUT

/api/v1/notification/{id}

Update an existing notification by its ID

Update a notification › path Parameters

idnumber · min: 1 · required
Id

Update a notification › Request Body

statusstring · enum
Notification status
Enum values:
SENT
FAILED
templatestring
Template (whatsapp | email)
parametersobject[]
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null
Dynamic parameters
stackstring
Stack error
originstring · enum
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring
Title
payloadstring
Payload
notificationTypestring · enum
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean
Read
userIdnumber · min: 1
user id
Example: 1

Update a notification › Responses

Notification updated

No data returned

PUT /api/v1/notification/{id}

curl --request PUT \
  --url /api/v1/notification/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "SENT",
  "template": "template",
  "parameters": [
    {
      "type": "type",
      "text": "text"
    }
  ],
  "data": {},
  "stack": "stack",
  "origin": "PUSH",
  "title": "title",
  "payload": "payload",
  "notificationType": "NEW_EVENT",
  "read": true,
  "userId": 1
}
'

shell

Show example in

Request Body Example

{
  "status": "SENT",
  "template": "template",
  "parameters": [
    {
      "type": "type",
      "text": "text"
    }
  ],
  "data": {},
  "stack": "stack",
  "origin": "PUSH",
  "title": "title",
  "payload": "payload",
  "notificationType": "NEW_EVENT",
  "read": true,
  "userId": 1
}

json

Example Responses

No example

plain

Delete a notification

DELETE

/api/v1/notification/{id}

Delete a notification by its ID for the current user

Delete a notification › path Parameters

idnumber · min: 1 · required
Id

Delete a notification › Responses

Notification deleted

No data returned

DELETE /api/v1/notification/{id}

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

shell

Show example in

Example Responses

No example

plain

Send a notification

POST

/api/v1/notification/send

Send a new notification

Send a notification › Request Body

statusstring · enum · required
Notification status
Enum values:
SENT
FAILED
templatestring · required
Template (whatsapp | email)
parametersobject[] · required
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null · required
Dynamic parameters
originstring · enum · required
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring · required
Title
payloadstring · required
Payload
notificationTypestring · enum · required
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean · required
Read
userIdnumber · min: 1 · required
user id
Example: 1

stackstring
Stack error

Send a notification › Responses

Notification created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
phonestring · required
Phone
statusstring · enum · required
Notification status
Enum values:
SENT
FAILED
templatestring · required
Template (whatsapp | email)
parametersobject[] · required
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null · required
Dynamic parameters
originstring · enum · required
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring · required
Title
payloadstring · required
Payload
notificationTypestring · enum · required
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean · required
Read

stackstring
Stack error

POST /api/v1/notification/send

curl --request POST \
  --url /api/v1/notification/send \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "SENT",
  "template": "template",
  "parameters": [
    {
      "type": "type",
      "text": "text"
    }
  ],
  "data": {},
  "stack": "stack",
  "origin": "PUSH",
  "title": "title",
  "payload": "payload",
  "notificationType": "NEW_EVENT",
  "read": true,
  "userId": 1
}
'

shell

Show example in

Request Body Example

{
  "status": "SENT",
  "template": "template",
  "parameters": [
    {
      "type": "type",
      "text": "text"
    }
  ],
  "data": {},
  "stack": "stack",
  "origin": "PUSH",
  "title": "title",
  "payload": "payload",
  "notificationType": "NEW_EVENT",
  "read": true,
  "userId": 1
}

json

Example Responses

No example

json

application/json

Delete all notifications for current user

DELETE

/api/v1/notification/all

Delete all notifications for the currently authenticated user

Delete all notifications for current user › Responses

All notifications deleted

No data returned

DELETE /api/v1/notification/all

curl --request DELETE \
  --url /api/v1/notification/all

shell

Show example in

Example Responses

No example

plain

Mark notification as read

PATCH

/api/v1/notification/{id}/read

Mark a notification as read for the current user

Mark notification as read › path Parameters

idnumber · min: 1 · required
Id

Mark notification as read › Responses

Notification marked as read

No data returned

PATCH /api/v1/notification/{id}/read

curl --request PATCH \
  --url /api/v1/notification/:id/read

shell

Show example in

Example Responses

No example

plain

Parent Notification Preferences

Brein API

Notification

Get notifications for current user

GET

/api/v1/notification

Retrieve a paginated list of notifications for the currently authenticated user

Get notifications for current user › query Parameters

pagenumber
Current page
pageSizenumber
Page size

Get notifications for current user › Responses

dataobject[] · required
Data

pagenumber
Current page
pageSizenumber
Page size
totalnumber
Total
lastPagenumber
Last page
nextstring
Next page (endpoint)
previousstring
Previous page (endpoint)

GET /api/v1/notification

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

shell

Show example in

Example Responses

No example

json

application/json

Get notification by ID

GET

/api/v1/notification/{id}

Retrieve a specific notification by its ID

Get notification by ID › path Parameters

idnumber · min: 1 · required
Id

Get notification by ID › Responses

Notification detail

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
phonestring · required
Phone
statusstring · enum · required
Notification status
Enum values:
SENT
FAILED
templatestring · required
Template (whatsapp | email)
parametersobject[] · required
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null · required
Dynamic parameters
originstring · enum · required
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring · required
Title
payloadstring · required
Payload
notificationTypestring · enum · required
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean · required
Read

stackstring
Stack error

GET /api/v1/notification/{id}

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

shell

Show example in

Example Responses

No example

json

application/json

Update a notification

PUT

/api/v1/notification/{id}

Update an existing notification by its ID

Update a notification › path Parameters

idnumber · min: 1 · required
Id

Update a notification › Request Body

statusstring · enum
Notification status
Enum values:
SENT
FAILED
templatestring
Template (whatsapp | email)
parametersobject[]
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null
Dynamic parameters
stackstring
Stack error
originstring · enum
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring
Title
payloadstring
Payload
notificationTypestring · enum
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean
Read
userIdnumber · min: 1
user id
Example: 1

Update a notification › Responses

Notification updated

No data returned

PUT /api/v1/notification/{id}

curl --request PUT \
  --url /api/v1/notification/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "SENT",
  "template": "template",
  "parameters": [
    {
      "type": "type",
      "text": "text"
    }
  ],
  "data": {},
  "stack": "stack",
  "origin": "PUSH",
  "title": "title",
  "payload": "payload",
  "notificationType": "NEW_EVENT",
  "read": true,
  "userId": 1
}
'

shell

Show example in

Request Body Example

{
  "status": "SENT",
  "template": "template",
  "parameters": [
    {
      "type": "type",
      "text": "text"
    }
  ],
  "data": {},
  "stack": "stack",
  "origin": "PUSH",
  "title": "title",
  "payload": "payload",
  "notificationType": "NEW_EVENT",
  "read": true,
  "userId": 1
}

json

Example Responses

No example

plain

Delete a notification

DELETE

/api/v1/notification/{id}

Delete a notification by its ID for the current user

Delete a notification › path Parameters

idnumber · min: 1 · required
Id

Delete a notification › Responses

Notification deleted

No data returned

DELETE /api/v1/notification/{id}

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

shell

Show example in

Example Responses

No example

plain

Send a notification

POST

/api/v1/notification/send

Send a new notification

Send a notification › Request Body

statusstring · enum · required
Notification status
Enum values:
SENT
FAILED
templatestring · required
Template (whatsapp | email)
parametersobject[] · required
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null · required
Dynamic parameters
originstring · enum · required
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring · required
Title
payloadstring · required
Payload
notificationTypestring · enum · required
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean · required
Read
userIdnumber · min: 1 · required
user id
Example: 1

stackstring
Stack error

Send a notification › Responses

Notification created

idnumber · required
Id
createdAtstring · date-time · required
Creation Date
updatedAtstring · date-time · required
Updated Date
phonestring · required
Phone
statusstring · enum · required
Notification status
Enum values:
SENT
FAILED
templatestring · required
Template (whatsapp | email)
parametersobject[] · required
Dynamic parameters
Example: [{"type":"text","text":"value"}]
dataobject | null · required
Dynamic parameters
originstring · enum · required
Notification origin
Enum values:
PUSH
WHATSAPP
EMAIL
Default: PUSH
titlestring · required
Title
payloadstring · required
Payload
notificationTypestring · enum · required
Notification type
Enum values:
NEW_EVENT
NEW_PENDING
NEW_POST
NEW_POST_CLASSROOM
LOST_ARTICLE
LOST_ARTICLE_CLAIMED
LOST_ARTICLE_DELIVERED
NEWSLETTER
Default: NEW_EVENT
readboolean · required
Read

stackstring
Stack error

POST /api/v1/notification/send

curl --request POST \
  --url /api/v1/notification/send \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "SENT",
  "template": "template",
  "parameters": [
    {
      "type": "type",
      "text": "text"
    }
  ],
  "data": {},
  "stack": "stack",
  "origin": "PUSH",
  "title": "title",
  "payload": "payload",
  "notificationType": "NEW_EVENT",
  "read": true,
  "userId": 1
}
'

shell

Show example in

Request Body Example

{
  "status": "SENT",
  "template": "template",
  "parameters": [
    {
      "type": "type",
      "text": "text"
    }
  ],
  "data": {},
  "stack": "stack",
  "origin": "PUSH",
  "title": "title",
  "payload": "payload",
  "notificationType": "NEW_EVENT",
  "read": true,
  "userId": 1
}

json

Example Responses

No example

json

application/json

Delete all notifications for current user

DELETE

/api/v1/notification/all

Delete all notifications for the currently authenticated user

Delete all notifications for current user › Responses

All notifications deleted

No data returned

DELETE /api/v1/notification/all

curl --request DELETE \
  --url /api/v1/notification/all

shell

Show example in

Example Responses

No example

plain

Mark notification as read

PATCH

/api/v1/notification/{id}/read

Mark a notification as read for the current user

Mark notification as read › path Parameters

idnumber · min: 1 · required
Id

Mark notification as read › Responses

Notification marked as read

No data returned

PATCH /api/v1/notification/{id}/read

curl --request PATCH \
  --url /api/v1/notification/:id/read

shell

Show example in

Example Responses

No example

plain

Parent Notification Preferences