Skip to content
Home/
REST API Reference
/
/
News Item

News Item

A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.

typestring

The type of object.

Value:"news-item"
Example:"news-item"
idstring

The unique identifier for the news item which is given by Intercom.

Example:"141"
workspace_idstring

The id of the workspace which the news item belongs to.

Example:"t74hdn32"
titlestring

The title of the news item.

Example:"New feature: News Items"
bodystring

The news item body, which may contain HTML.

Example:"We are excited to announce the launch of News Items, a new content type in Intercom enabling you to announce product updates, company news, promotion
sender_idinteger

The id of the sender of the news item. Must be a teammate on the workspace.

Example:123
statestring

News items will not be visible to your users in the assigned newsfeeds until they are set live.

Enum:"draft""live"
Example:"live"
newsfeed_assignmentsArray of objects(Newsfeed Assignment)

A list of newsfeed_assignments to assign to the specified newsfeed.

labelsArray of strings

Label names displayed to users to categorize the news item.

cover_image_urlstring or null, (uri)

URL of the image used as cover. Must have .jpg or .png extension.

Example:"https://example.com/cover.jpg"
reactionsArray of strings

Ordered list of emoji reactions to the news item. When empty, reactions are disabled.

deliver_silentlyboolean

When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.

Example:true
created_atinteger, (timestamp)

Timestamp for when the news item was created.

Example:1610589632
updated_atinteger, (timestamp)

Timestamp for when the news item was last updated.

Example:1610589632
{
  "type": "news-item",
  "id": "141",
  "workspace_id": "t74hdn32",
  "title": "New feature: News Items",
  "body": "We are excited to announce the launch of News Items, a new content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.",
  "sender_id": 123,
  "state": "live",
  "newsfeed_assignments": [
    { … }
  ],
  "labels": [
    "Product Update"
  ],
  "cover_image_url": "https://example.com/cover.jpg",
  "reactions": [
    "👍"
  ],
  "deliver_silently": true,
  "created_at": 1610589632,
  "updated_at": 1610589632
}