Skip to content

Announcements

Get all announcements

Section titled “ Get all announcements ”
GET v3/announcements

Returns all announcements in an account.

[
  {
    "id": 29965434,
    "title": "Celebrate christmas event",
    "description": "",
    "assigned": [5317500, 2877438],
    "created_at": "2019-01-15T12:21:40+00:00",
    "updated_at": "2019-01-15T12:21:40+00:00",
    "comments_allowed": true,
    "pinned": false,
    "comments": {
      "count": 0
    }
  }
]

Get announcement

Section titled “ Get announcement ”
GET v3/announcements/3628560

Returns the specified announcement.

{
  "id": 29965434,
  "title": "Celebrate christmas event",
  "description": "",
  "comments_allowed": true,
  "pinned": false
}

Create announcement

Section titled “ Create announcement ”
POST v3/announcements

Creates a new announcement.

{
  "title": "Celebrate christmas event",
  "assigned": [
    5317500,
    2877438
  ],
  "valid_till": "24hours"
}
200 OK is returned along with the announcement JSON if the record is added.

Update announcement

Section titled “ Update announcement ”
PUT v3/announcement/3628560

Updates an announcement.

{
  "title": "Christmas celebration for this year"
}
200 OK Returned if the record is updated.
403 Forbidden Returned for invalid access.

Delete announcement

Section titled “ Delete announcement ”
DELETE v3/announcement/3628560

Deletes the specified announcement.

204 No Content is returned if successful. 403 Forbidden is returned for invalid access.

Get all comments

Section titled “ Get all comments ”
GET v3/announcements/3628560/comments returns all comments for the specified announcement. 
[
  {
    "id": 4475533,
    "description": "Celebrations will start from next week",
    "announcement": 29965434,
    "attachments": []
  },
  {
    "id": 44768902,
    "description": "Here are the screenshots for celebration",
    "announcement": 29965434,
    "attachments": [
      {
        "id": 2041111053,
        "name": "Christmas.png",
        "file_type": "png"
      }
    ]
  }
]

Get comment

Section titled “ Get comment ”
GET v3/announcements/3628560/comments/4475533 returns the specified comment. 
{
  "id": 4475533,
  "description": "Celebrations will start from next week",
  "announcement": 29965434,
  "attachments": []
}

Create comment

Section titled “ Create comment ”
POST v3/announcements/3628560/comments creates a new comment. 
{
  "description": "All employees participation is required"
}
200 OK is returned with the created comment.

Update comment

Section titled “ Update comment ”
PUT v3/announcements/3628560/comments/4475533 updates a comment. 
{
  "description": "Call with client"
}
200 OK is returned with the updated comment.

Delete comment

Section titled “ Delete comment ”
DELETE v3/announcements/3628560/comments/4475533 deletes the specified comment.
200 OK is returned if successful.
403 Forbidden is returned for invalid access.