Sign in

v68

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-0189430445.4 KB
Announcements

Update Announcement

Update a textual announcement visible to some set of users based on department and location.

post/rest/api/v1/updateannouncement

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Request body

startTimestring date-time required

The date and time at which the announcement becomes active.

endTimestring date-time required

The date and time at which the announcement expires.

titlestring required

The headline of the announcement.

emojistring

An emoji used to indicate the nature of the announcement.

sourceDocumentIdstring

The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread).

hideAttributionboolean

Whether or not to hide an author attribution.

channel'MAIN' | 'SOCIAL_FEED'

This determines whether this is a Social Feed post or a regular announcement.

postType'TEXT' | 'LINK'

This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site.

isPrioritizedboolean

Used by the Social Feed to pin posts to the front of the feed.

viewUrlstring

URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED".

idinteger required

The opaque id of the announcement.

Response

OK

startTimestring date-time

The date and time at which the announcement becomes active.

endTimestring date-time

The date and time at which the announcement expires.

titlestring

The headline of the announcement.

emojistring

An emoji used to indicate the nature of the announcement.

sourceDocumentIdstring

The Glean Document ID of the source document this Announcement was created from (e.g. Slack thread).

hideAttributionboolean

Whether or not to hide an author attribution.

channel'MAIN' | 'SOCIAL_FEED'

This determines whether this is a Social Feed post or a regular announcement.

postType'TEXT' | 'LINK'

This determines whether this is an external-link post or a regular announcement post. TEXT - Regular announcement that can contain rich text. LINK - Announcement that is linked to an external site.

isPrioritizedboolean

Used by the Social Feed to pin posts to the front of the feed.

viewUrlstring

URL for viewing the announcement. It will be set to document URL for announcements from other datasources e.g. simpplr. Can only be written when channel="SOCIAL_FEED".

draftIdinteger

The opaque id of the associated draft.

trackingTokenstring

An opaque token that represents this particular UGC. To be used for /feedback reporting.

idinteger

The opaque id of the announcement.

createTimestampinteger

Server Unix timestamp of the creation time (in seconds since epoch UTC).

lastUpdateTimestampinteger

Server Unix timestamp of the last update time (in seconds since epoch UTC).

isPublishedboolean

Whether or not the announcement is published.

Example response

{
  "draftId": 342
}