Humtog API

# Announcement

# Get Announcements

# Resource URL

https://humtog.com/api/announcements

# Resource Method

GET

# Example Response

{
     "data": [
        {
            "id": 1,
            "active_until": "expirationDate",
            "content": "contentOfAnnouncement",
            "created_at": "dateOfCreation",
        }
    ]
}

# Create Announcement

# Resource URL

https://humtog.com/api/announcements

# Resource Method

POST

# Params

Name Required Type Description
body Yes string Content of announcement
title Yes string Title of announcement
duration Yes integer Duration of announcement in days

# Example Response

{
     "data": [
        {
            "id": 1,
            "active_until": "expirationDate",
            "content": "contentOfAnnouncement",
            "created_at": "dateOfCreation",
        }
    ]
}

# Mark Announcement as Seen

# Resource URL

https://humtog.com/api/announcements/:announcement_id/seen

# Resource Method

POST

# Example Response

{
     "data": [
        {
            "id": 1,
            "active_until": "expirationDate",
            "content": "contentOfAnnouncement",
            "created_at": "dateOfCreation",
        }
    ]
}

# Delete Announcement

# Resource URL

https://humtog.com/api/announcements/:announcement_id/seen

# Resource Method

DELETE

# Example Response

{
     "data": [
        {
            "id": 1,
            "active_until": "expirationDate",
            "content": "contentOfAnnouncement",
            "created_at": "dateOfCreation",
        }
    ]
}

← Image →