Create News Item Request | Intercom and Fin Developer Platform

REST API Reference

Create News Item Request

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

titlestringrequired

The title of the news item.

Example:"Halloween is here!"

bodystring

The news item body, which may contain HTML.

Example:"<p>New costumes in store for this spooky season</p>"

sender_idintegerrequired

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"

deliver_silentlyboolean

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

Example:true

labelsArray of strings

Label names displayed to users to categorize the news item.

Example:

[
  "Product",
  "Update",
  "New"
]

reactionsArray of strings

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

Example:

[
  "😆",
  "😅"
]

newsfeed_assignmentsArray of objects(Newsfeed Assignment)

A list of newsfeed_assignments to assign to the specified newsfeed.

{
  "title": "Halloween is here!",
  "body": "<p>New costumes in store for this spooky season</p>",
  "sender_id": 123,
  "state": "live",
  "deliver_silently": true,
  "labels": [
    "Product",
    "Update",
    "New"
  ],
  "reactions": [
    "😆",
    "😅"
  ],
  "newsfeed_assignments": [
    { … }
  ]
}