Update a news item

Home

REST API Reference

News

Update a news item

SecurityHTTP: bearerAuth

Request

path Parameters

required

integer

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

Example: 123

header Parameters

Intercom-Version

string (intercom_version)

Default: 2.11

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

Enum: "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" "Unstable"

Example: 2.11

Request Body schema: application/json

title required	string The title of the news item.
body	string The news item body, which may contain HTML.
sender_id required	integer The id of the sender of the news item. Must be a teammate on the workspace.
state	string News items will not be visible to your users in the assigned newsfeeds until they are set live. Enum: "draft" "live"
deliver_silently	boolean When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge.
labels	Array of strings Label names displayed to users to categorize the news item.
reactions	Array of strings or null Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
	Array of objects (Newsfeed Assignment) A list of newsfeed_assignments to assign to the specified newsfeed.

put

/news/news_items/{id}

Request samples
Payload
curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R
5 more
application/json
successful
{
"title": "Christmas is here!",
"body": "<p>New gifts in store for the jolly season</p>",
"sender_id": 991271829,
"reactions": [
"😝",
"😂"
]
}

Responses

200

successful

Response Schema: application/json

type	string The type of object. Value: "news-item"
id	string The unique identifier for the news item which is given by Intercom.
workspace_id	string The id of the workspace which the news item belongs to.
title	string The title of the news item.
body	string The news item body, which may contain HTML.
sender_id	integer The id of the sender of the news item. Must be a teammate on the workspace.
state	string News items will not be visible to your users in the assigned newsfeeds until they are set live. Enum: "draft" "live"
	Array of objects (Newsfeed Assignment) A list of newsfeed_assignments to assign to the specified newsfeed.
labels	Array of strings or null Label names displayed to users to categorize the news item.
cover_image_url	string or null <uri> URL of the image used as cover. Must have .jpg or .png extension.
reactions	Array of strings or null Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
deliver_silently	boolean When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
created_at	integer <timestamp> Timestamp for when the news item was created.
updated_at	integer <timestamp> Timestamp for when the news item was last updated.

401

Unauthorized

404

News Item Not Found

Response samples
200
401
404
application/json
successful
{
"id": "149",
"type": "news-item",
"workspace_id": "this_is_an_id497_that_should_be_at_least_",
"title": "Christmas is here!",
"body": "<p>New gifts in store for the jolly season</p>",
"sender_id": 991271829,
"state": "live",
"labels": [ ],
"cover_image_url": null,
"reactions": [
"😝",
"😂"
],
"deliver_silently": false,
"created_at": 1715077995,
"updated_at": 1715077996,
"newsfeed_assignments": [ ]
}