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

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"
]
cover_image_urlstring, (uri)

URL of the image to use as the cover. Must contain .png or .jpg in lower case, so .jpeg and .PNG are rejected. Intercom copies the image and serves it from its own signed URL.

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

Ordered list of emoji reactions to the news item. Send an empty list to disable reactions. Send at most five, each a single Unicode code point, so an emoji with a skin tone, a joiner sequence or a variation selector (such as ❤️) is rejected. More than five returns a 400, but the news item is still saved as a draft, with no reactions or cover image.

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"
  ],
  "cover_image_url": "https://example.com/cover.jpg",
  "reactions": [
    "😆",
    "😅"
  ],
  "newsfeed_assignments": [
    { … }
  ]
}