Mark Announcement Read

Beta

POST/v1/messaging/announcements/{id}/actions/read

Idempotent with Idempotency-Key header. Learn more

Marks an announcement as read for the calling actor.

Permissions requiredValues:messaging:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Announcement ID.

include[]optional arrayenumValues:resource

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

idstring

Announcement ID.

objectstringenumValues:announcement

Resource type identifier.

scopestringenumValues:accountplatform

Reach of the announcement.

account: shown only to users within this account.
platform: shown to every user across all accounts.

categorystringenumValues:chat.messagechat.mentionchat.added

Category of the announcement.

titlestring

Human-readable title.

bodystringnullable

Preview/body text.

statusstringenumValues:unseenseenread

Lifecycle status of the announcement for the calling actor, derived from their seen/read/dismissed receipt.

unseen: not yet surfaced in the caller's feed.
seen: surfaced in the feed but not yet opened.
read: opened by the caller.
dismissed: dismissed by the caller.

prioritystringenumValues:lownormalhigh

Delivery priority.

resourceentityExpandablenullable

The app resource this announcement links to.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

publish_atstring (date-time)

When the announcement becomes visible in the feed.

expires_atstring (date-time)nullable

When the announcement stops being shown.

seen_atstring (date-time)nullable

When the calling actor first saw the announcement.

read_atstring (date-time)nullable

When the calling actor opened the announcement.

dismissed_atstring (date-time)nullable

When the calling actor dismissed the announcement.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

Responses

200

Successful response for Mark Announcement Read

Mark Announcement Read

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const announcement = await client.messaging.announcements.actions.read(
  'an_01c4d5e6f7a8b9c0d1e2f3a4',
);

console.log(announcement.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const announcement = await client.messaging.announcements.actions.read(
  'an_01c4d5e6f7a8b9c0d1e2f3a4',
);

console.log(announcement.id);

200 example

{
  "id": "an_01c4d5e6f7a8b9c0d1e2f3a4",
  "object": "announcement",
  "scope": "account",
  "category": "order.updated",
  "title": "Scheduled maintenance",
  "body": "The platform will be briefly unavailable tonight at 2am UTC.",
  "status": "unseen",
  "priority": "normal",
  "resource": null,
  "publish_at": "2026-05-10T00:00:00Z",
  "expires_at": null,
  "seen_at": null,
  "read_at": null,
  "dismissed_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "an_01c4d5e6f7a8b9c0d1e2f3a4",
  "object": "announcement",
  "scope": "account",
  "category": "order.updated",
  "title": "Scheduled maintenance",
  "body": "The platform will be briefly unavailable tonight at 2am UTC.",
  "status": "unseen",
  "priority": "normal",
  "resource": null,
  "publish_at": "2026-05-10T00:00:00Z",
  "expires_at": null,
  "seen_at": null,
  "read_at": null,
  "dismissed_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Mark Announcement Read

Authorization

Path Parameters

Query Parameters

Returns

Responses