APIs | TomatoPHP

Notifications List

get

Show All notifications of current login user by token

Responses

200Success

application/json

get

GET /api/notifications HTTP/1.1
Host: cm.test
Accept: */*

200Success

{
  "success": true,
  "message": "text",
  "data": "text"
}

Clear Notifications

post

Clear all notifications of current user.

Body

objectOptional

Responses

200Success

application/json

post

POST /api/notifications/clear HTTP/1.1
Host: cm.test
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

{
  "success": true,
  "message": "text",
  "data": [
    "text"
  ]
}

Delete Notification

delete

Delete Selected notifications by ID

Path parameters

idstringRequired

Body

objectOptional

Responses

200Success

application/json

delete

DELETE /api/notifications/{id}/delete HTTP/1.1
Host: cm.test
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200Success

{
  "success": true,
  "message": "text",
  "data": [
    "text"
  ]
}

Make Notification as Read

post

You can make the selected notification by id flag to be is_read=true

Path parameters

idstringRequired

Body

objectOptional

Responses

200Success

application/json

404Error

application/json

post

POST /api/notifications/{id}/read HTTP/1.1
Host: cm.test
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "success": true,
  "message": "text",
  "data": [
    "text"
  ]
}

Update Notification Token

post

update notification token for FCM integration token

Body

tokenstring | nullOptional

Responses

200Success

application/json

422

Validation error

application/json

post

POST /api/notifications/toggle HTTP/1.1
Host: cm.test
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "token": null
}

{
  "success": true,
  "message": "text",
  "body": [
    "text"
  ]
}