Announcements

Get active announcements for current user (works for anonymous users)

get

Responses

200

Successful response

application/json

idnumberRequired

titlestringRequired

descriptionstringRequired

imageUrlany ofRequired

stringOptional

or

nullOptional

actionButtonLabelany ofRequired

stringOptional

or

nullOptional

actionButtonUrlany ofRequired

stringOptional

or

nullOptional

startDateTimestringRequired

endDateTimestringRequired

statusstring · enumRequiredPossible values:

createdAtstringRequired

updatedAtstringRequired

authorAvatarUrlany ofRequired

stringOptional

or

nullOptional

500

Internal server error

application/json

get

/announcements/active

HTTPcURLJavaScriptPython

GET /api/v2/announcements/active HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "id": 1,
    "title": "text",
    "description": "text",
    "imageUrl": "text",
    "actionButtonLabel": "text",
    "actionButtonUrl": "text",
    "startDateTime": "text",
    "endDateTime": "text",
    "status": "ACTIVE",
    "createdAt": "text",
    "updatedAt": "text",
    "authorAvatarUrl": "text"
  }
]

Mark an announcement as viewed

post

Authorizations

Authorization

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idnumberRequired

Responses

200

Successful response

application/json

okconst: Required

400

Invalid input data

application/json

401

Authorization not provided

application/json

403

Insufficient access

application/json

500

Internal server error

application/json

post

/announcements/{id}/viewed

HTTPcURLJavaScriptPython

POST /api/v2/announcements/{id}/viewed HTTP/1.1
Host: api.ethos.network
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "ok": true
}