Notifications

Get pending notifications for user

get
Authorizations
Query parameters
limitinteger · max: 50OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200

Successful response

application/json
get
/notifications/me
GET /api/v2/notifications/me HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "values": [
    {
      "type": "SIMPLE",
      "hydrated": null
    },
    {
      "id": 1,
      "date": "text"
    },
    {
      "type": "SIMPLE",
      "data": {
        "title": "text",
        "body": "text"
      }
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

Get notifications stats for user

get
Authorizations
Responses
200

Successful response

application/json
get
/notifications/stats/me
GET /api/v2/notifications/stats/me HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "unreadCount": 1
}

Mark notifications as read for user

post
Authorizations
Body
notificationIdsnumber[]Required
Responses
200

Successful response

application/json
post
/notifications/me/mark-as-read
POST /api/v2/notifications/me/mark-as-read HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "notificationIds": [
    1
  ]
}
{
  "read": 1
}

Get notification settings for user

get
Authorizations
Responses
200

Successful response

application/json
get
/notifications/me/settings
GET /api/v2/notifications/me/settings HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "SIMPLE": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "VOUCH": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "VOUCH_INCREASED": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "UNVOUCH": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "REVIEW": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "INVITATION_ACCEPTED": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "REPLY": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "SLASH_CREATE": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "SLASH_COMPLETE": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "SLASH_COMPLETE_SUBSCRIBED": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "CONTRIBUTION_STREAK_ENDING": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "BROKER_POST_EXPIRING": {
    "listDisabled": true,
    "pushDisabled": true
  },
  "BROKER_POST_EXPIRED": {
    "listDisabled": true,
    "pushDisabled": true
  }
}

Update notification settings for user

put
Authorizations
Body
Responses
200

Successful response

application/json
Responseany
put
/notifications/me/settings
PUT /api/v2/notifications/me/settings HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 778

{
  "settings": {
    "SIMPLE": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "VOUCH": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "VOUCH_INCREASED": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "UNVOUCH": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "REVIEW": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "INVITATION_ACCEPTED": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "REPLY": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "SLASH_CREATE": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "SLASH_COMPLETE": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "SLASH_COMPLETE_SUBSCRIBED": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "CONTRIBUTION_STREAK_ENDING": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "BROKER_POST_EXPIRING": {
      "listDisabled": true,
      "pushDisabled": true
    },
    "BROKER_POST_EXPIRED": {
      "listDisabled": true,
      "pushDisabled": true
    }
  }
}
No content
PreviousMarketsNextNfts

Last updated