Intercom API (unofficial showcase)
POST/news/news_items

Create a news item

Creates a news item that can announce updates, company news, promotions, or events. Supply title and sender_id; the sender must be a teammate, and state can be set to draft or live. Assign the item to newsfeeds with newsfeed_assignments.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 8 body fields
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; supported values include the versions listed in the schema.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

News item details. When a body is provided, title and sender_id are required.

titlestringrequired
The title of the news item.
bodystringoptional
The news item body, which may contain HTML.
sender_idintegerrequired
The id of the sender of the news item. Must be a teammate on the workspace.
statestringoptional
News items will not be visible to your users in the assigned newsfeeds until they are set live.
Allowed:draftlive
deliver_silentlybooleanoptional
When set to `true`, the news item will appear in the messenger newsfeed without showing a notification badge.
labelsarray<string>optional
Label names displayed to users to categorize the news item.
reactionsarray<string>optional
Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
newsfeed_assignmentsarray<NewsfeedAssignment>optional
A list of newsfeed_assignments to assign to the specified newsfeed.

2 status codes
200Returns the created news item, including its identifier, title, body, state, sender, newsfeed assignments, labels, reactions, and timestamps.
typestringoptional
The type of object.
Allowed:news-item
idstringoptional
The unique identifier for the news item which is given by Intercom.
workspace_idstringoptional
The id of the workspace which the news item belongs to.
titlestringoptional
The title of the news item.
bodystringoptional
The news item body, which may contain HTML.
sender_idintegeroptional
The id of the sender of the news item. Must be a teammate on the workspace.
statestringoptional
News items will not be visible to your users in the assigned newsfeeds until they are set live.
Allowed:draftlive
newsfeed_assignmentsarray<NewsfeedAssignment>optional
A list of newsfeed_assignments to assign to the specified newsfeed.
labelsarray<string>optional
Label names displayed to users to categorize the news item.
cover_image_urlstringoptional
URL of the image used as cover. Must have .jpg or .png extension.
reactionsarray<string>optional
Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
deliver_silentlybooleanoptional
When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
created_atintegeroptional
Timestamp for when the news item was created.
updated_atintegeroptional
Timestamp for when the news item was last updated.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized; send valid API credentials. When you provide a body, title and sender_id are required, and sender_id must identify a workspace teammate. state must be draft or live.