Announcements

Announcements are company-wide messages that can be targeted to specific groups. They are automatically published on creation.

Required scope: read:announcements, write:announcements.

Endpoints

GET

/api/open/v1/announcements

List published announcements (paginated)

GET

/api/open/v1/announcements/{id}

Get a single announcement

POST

/api/open/v1/announcements

Create and publish an announcement

PUT

/api/open/v1/announcements/{id}

Update an announcement

DELETE

/api/open/v1/announcements/{id}

Delete an announcement (returns 204)

Create

curl -X POST https://customer.monotree.com/api/open/v1/announcements \
  -H "Authorization: Bearer mono_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Office closed on Friday",
    "subtitle": "Facility update",
    "body": "Due to maintenance, the office will be closed this Friday.",
    "groups": [1, 3]
  }'

Request body

Field	Type	Notes
`title`	string	Required.
`body`	string	Required.
`subtitle`	string	Optional.
`groups`	array of integers	Optional. Group IDs to target. Empty/omitted = company-wide.

Update

All fields are optional on PUT. Send only the fields you want to change.

curl -X PUT https://customer.monotree.com/api/open/v1/announcements/456 \
  -H "Authorization: Bearer mono_your_token_here" \
  -H "Content-Type: application/json" \
  -d '{"title": "Updated title"}'

Response

{
  "data": {
    "id": 456,
    "title": "Office closed on Friday",
    "subtitle": "Facility update",
    "body": "Due to maintenance, the office will be closed this Friday.",
    "author": {
      "id": 1,
      "name": "John Doe",
      "email": "john@example.com",
      "type": "user",
      "groups": []
    },
    "groups": [
      { "id": 1, "name": "All Staff", "type": "custom", "created_at": "2026-01-15T10:00:00+00:00" }
    ],
    "is_published": true,
    "is_commentable": true,
    "is_confirmable": false,
    "is_pinned": false,
    "comments_count": 0,
    "completions_count": 0,
    "confirmations_count": 0,
    "starts_at": "2026-03-22",
    "published_at": "2026-03-22T10:00:00+00:00",
    "created_at": "2026-03-22T10:00:00+00:00",
    "updated_at": "2026-03-22T10:00:00+00:00"
  }
}