The Wayback Machine - https://web.archive.org/web/20220128191033/https://docs.joinmastodon.org/methods/announcements/

announcements

For announcements set by administration.

get
View all announcements

https://mastodon.example/api/v1/announcements

See all currently active announcements set by admins.

Returns: Array of Announcement
OAuth: User token
Version history:
3.1.0 - added

Request

Headers
Authorization
required
string
Bearer <user token>
Query Parameters
with_dismissed
optional
boolean
If true, response will include announcements dismissed by the user. Defaults to false.

Response

200: Success

Currently active announcements

[
  {
    "id": "8",
    "content": "<p>Looks like there was an issue processing audio attachments without embedded art since yesterday due to an experimental new feature. That issue has now been fixed, so you may see older posts with audio from other servers pop up in your feeds now as they are being finally properly processed. Sorry!</p>",
    "starts_at": null,
    "ends_at": null,
    "all_day": false,
    "published_at": "2020-07-03T01:27:38.726Z",
    "updated_at": "2020-07-03T01:27:38.752Z",
    "read": true,
    "mentions": [],
    "statuses": [],
    "tags": [],
    "emojis": [],
    "reactions": [
      {
        "name": "bongoCat",
        "count": 9,
        "me": false,
        "url": "https://files.mastodon.social/custom_emojis/images/000/067/715/original/fdba57dff7576d53.png",
        "static_url": "https://files.mastodon.social/custom_emojis/images/000/067/715/static/fdba57dff7576d53.png"
      },
      {
        "name": "thonking",
        "count": 1,
        "me": false,
        "url": "https://files.mastodon.social/custom_emojis/images/000/098/690/original/a8d36edc4a7032e8.png",
        "static_url": "https://files.mastodon.social/custom_emojis/images/000/098/690/static/a8d36edc4a7032e8.png"
      },
      {
        "name": "AAAAAA",
        "count": 1,
        "me": false,
        "url": "https://files.mastodon.social/custom_emojis/images/000/071/387/original/AAAAAA.png",
        "static_url": "https://files.mastodon.social/custom_emojis/images/000/071/387/static/AAAAAA.png"
      },
      {
        "name": "🤔",
        "count": 1,
        "me": true
      }
    ]
  }
]

post
Dismiss an announcement

https://mastodon.example/api/v1/announcements/:id/dismiss

Allows a user to mark the announcement as read.

Returns: Empty
OAuth: User token + write:accounts
Version history:
3.1.0 - added

Request

Headers
Authorization
required
string
Bearer <user token>
Path Parameters
:id
required
string
Local ID of an announcement in the database.

Response

200: Success
{}

put
Add reaction

https://mastodon.example/api/v1/announcements/:id/reactions/:name

React to an announcement with an emoji.

Returns: Empty
OAuth: User token + write:favourites
Version history:
3.1.0 - added

Request

Headers
Authorization
required
string
Bearer <user token>
Path Parameters
:id
required
string
Local ID of an announcement in the database.
:name
required
string
Unicode emoji, or shortcode of custom emoji

Response

200: Success
{}

422: Unprocessable Entity
{"error":"Validation failed: Name is not a recognized emoji"}

delete
Remove reaction

https://mastodon.example/api/v1/announcements/:id/reactions/:name

Undo a react emoji to an announcement.

Returns: Empty
OAuth: User token + write:favourites
Version history:
3.1.0 - added

Request

Headers
Authorization
required
string
Bearer <user token>
Path Parameters
:id
required
string
Local ID of an announcement in the database.
:name
required
string
Unicode emoji, or shortcode of custom emoji

Response

200: Success
{}

422: Unprocessable Entity
{"error":"Validation failed: Name is not a recognized emoji"}

Last updated July 3, 2020 · Improve this page