Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
News

Create a news item

You can create a news item

post/news/news_items

Headers

Intercom-Version'1.0' | '1.1' | '1.2' | '1.3' | '1.4' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4' | '2.5' | '2.6' | '2.7' | '2.8' | '2.9' | '2.10' | '2.11' | '2.12' | '2.13' | '2.14'

Intercom API version.</br>By default, it's equal to the version set in the app package.

Example:2.14

Request body

titlestring required

The title of the news item.

bodystring

The news item body, which may contain HTML.

sender_idinteger required

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

state'draft' | 'live'

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

deliver_silentlyboolean

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

labelsstring[]

Label names displayed to users to categorize the news item.

reactionsstring[]

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

Example request

{
  "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": [
    {
      "newsfeed_id": 198313,
      "published_at": 1674917488
    }
  ]
}

Response

successful

type'news-item'

The type of object.

idstring

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

workspace_idstring

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

titlestring

The title of the news item.

bodystring

The news item body, which may contain HTML.

sender_idinteger

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

state'draft' | 'live'

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

labelsstring[]

Label names displayed to users to categorize the news item.

cover_image_urlstring uri nullable

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

reactionsstring[]

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.

created_atinteger

Timestamp for when the news item was created.

updated_atinteger

Timestamp for when the news item was last updated.

Example response

{
  "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": [
    {
      "newsfeed_id": 198313,
      "published_at": 1674917488
    }
  ],
  "labels": [
    "Product Update"
  ],
  "cover_image_url": "https://example.com/cover.jpg",
  "reactions": [
    "👍"
  ],
  "deliver_silently": true,
  "created_at": 1610589632,
  "updated_at": 1610589632
}