Skip to content
Home/
REST API Reference
/
/
Update a news item

Update a news item

Request

You can update a news item.

You can also send this request with PATCH; it behaves the same as PUT.

title, body, state, deliver_silently and cover_image_url keep their current values when you leave them out. labels and newsfeed_assignments do not: leaving either out clears it, so send the full list on every update. Leaving reactions out disables reactions, although the list in the response does not change.

Requires the read_write_news_scope OAuth scope.

Security
bearerAuth
Path
news_item_idintegerrequired

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

Example:123
Headers
Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:2.17
Bodyapplication/json
titlestring

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. Send the full list; the labels you leave out are removed.

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.

Example:
[
  "😆",
  "😅"
]
newsfeed_assignmentsArray of objects(Newsfeed Assignment)

A list of newsfeed_assignments to assign to the specified newsfeed. Send the full list; the assignments you leave out are removed.

curl -i -X PUT \
  https://api.intercom.io/news/news_items/123 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.17' \
  -d '{
    "title": "Christmas is here!",
    "body": "<p>New gifts in store for the jolly season</p>",
    "sender_id": 991267845,
    "reactions": [
      "😝",
      "😂"
    ]
  }'

Responses

successful

Bodyapplication/json
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, sorted with uppercase letters before lowercase.

cover_image_urlstring or null, (uri)

URL of the image used as cover. Must have .jpg or .png extension. Intercom copies the image you send on write, so the URL returned here is a signed Intercom URL that expires; fetch the news item again for a fresh one.

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

Ordered list of emoji reactions to the news item. When empty, reactions are disabled. An update that leaves out reactions also disables them but leaves this list as it was.

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
published_atinteger or null, (timestamp)

Timestamp for when the news item last went live. Null if the news item has never been live.

Example:1610589632
Response
{
  "id": "37",
  "type": "news-item",
  "workspace_id": "this_is_an_id544_that_should_be_at_least_",
  "title": "Christmas is here!",
  "body": "<p>New gifts in store for the jolly season</p>",
  "sender_id": 991267845,
  "state": "live",
  "labels": [],
  "cover_image_url": null,
  "reactions": [
    "😝",
    "😂"
  ],
  "deliver_silently": false,
  "created_at": 1734537803,
  "updated_at": 1734537804,
  "published_at": 1734537804,
  "newsfeed_assignments": []
}