The intercom API reference.
The intercom API reference.
A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.
The id of the workspace which the news item belongs to.
The news item body, which may contain HTML.
The id of the sender of the news item. Must be a teammate on the workspace.
News items will not be visible to your users in the assigned newsfeeds until they are set live.
A list of newsfeed_assignments to assign to the specified newsfeed.
Label names displayed to users to categorize the news item.
URL of the image used as cover. Must have .jpg or .png extension.
Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
Timestamp for when the news item was created.
{ "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": [ { … } ], "labels": [ "Product Update" ], "cover_image_url": "https://example.com/cover.jpg", "reactions": [ "👍" ], "deliver_silently": true, "created_at": 1610589632, "updated_at": 1610589632 }
A newsfeed is a collection of news items, targeted to a specific audience.
Newsfeeds currently cannot be edited through the API, please refer to this article to set up your newsfeeds in Intercom.
The name of the newsfeed. This name will never be visible to your users.
Timestamp for when the newsfeed was created.
{ "id": "12312", "type": "newsfeed", "name": "My Newsfeed", "created_at": 1674917488, "updated_at": 1674917488 }
Assigns a news item to a newsfeed.
The unique identifier for the newsfeed which is given by Intercom. Publish dates cannot be in the future, to schedule news items use the dedicated feature in app (see this article).
{ "newsfeed_id": 198313, "published_at": 1674917488 }
curl -i -X GET \
https://api.intercom.io/news/news_items \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
successful
Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
An array of News Items
The unique identifier for the news item which is given by Intercom.
The id of the workspace which the news item belongs to.
The news item body, which may contain HTML.
The id of the sender of the news item. Must be a teammate on the workspace.
News items will not be visible to your users in the assigned newsfeeds until they are set live.
A list of newsfeed_assignments to assign to the specified newsfeed.
Label names displayed to users to categorize the news item.
URL of the image used as cover. Must have .jpg or .png extension.
Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
Timestamp for when the news item was created.
{ "type": "list", "pages": { "page": 1, "per_page": 10, "total_pages": 1, "type": "pages" }, "data": [ { … }, { … } ], "total_count": 2 }
The news item body, which may contain HTML.
The id of the sender of the news item. Must be a teammate on the workspace.
News items will not be visible to your users in the assigned newsfeeds until they are set live.
When set to true
, the news item will appear in the messenger newsfeed without showing a notification badge.
Label names displayed to users to categorize the news item.
Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
curl -i -X POST \
https://api.intercom.io/news/news_items \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: 2.11' \
-d '{
"title": "Halloween is here!",
"body": "<p>New costumes in store for this spooky season</p>",
"labels": [
"Product",
"Update",
"New"
],
"sender_id": 991267734,
"deliver_silently": true,
"reactions": [
"😆",
"😅"
],
"state": "live",
"newsfeed_assignments": [
{
"newsfeed_id": 53,
"published_at": 1664638214
}
]
}'
successful
The id of the workspace which the news item belongs to.
The news item body, which may contain HTML.
The id of the sender of the news item. Must be a teammate on the workspace.
News items will not be visible to your users in the assigned newsfeeds until they are set live.
A list of newsfeed_assignments to assign to the specified newsfeed.
Label names displayed to users to categorize the news item.
URL of the image used as cover. Must have .jpg or .png extension.
Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
Timestamp for when the news item was created.
{ "id": "33", "type": "news-item", "workspace_id": "this_is_an_id498_that_should_be_at_least_", "title": "Halloween is here!", "body": "<p>New costumes in store for this spooky season</p>", "sender_id": 991267734, "state": "live", "labels": [ "New", "Product", "Update" ], "cover_image_url": null, "reactions": [ "😆", "😅" ], "deliver_silently": true, "created_at": 1719492978, "updated_at": 1719492978, "newsfeed_assignments": [ { … } ] }
curl -i -X GET \
'https://api.intercom.io/news/news_items/{news_item_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
successful
The id of the workspace which the news item belongs to.
The news item body, which may contain HTML.
The id of the sender of the news item. Must be a teammate on the workspace.
News items will not be visible to your users in the assigned newsfeeds until they are set live.
A list of newsfeed_assignments to assign to the specified newsfeed.
Label names displayed to users to categorize the news item.
URL of the image used as cover. Must have .jpg or .png extension.
Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
Timestamp for when the news item was created.
{ "id": "34", "type": "news-item", "workspace_id": "this_is_an_id502_that_should_be_at_least_", "title": "We have news", "body": "<p>Hello there,</p>", "sender_id": 991267737, "state": "live", "labels": [], "cover_image_url": null, "reactions": [ null, null, null, null ], "deliver_silently": false, "created_at": 1719492979, "updated_at": 1719492979, "newsfeed_assignments": [ { … } ] }
The news item body, which may contain HTML.
The id of the sender of the news item. Must be a teammate on the workspace.
News items will not be visible to your users in the assigned newsfeeds until they are set live.
When set to true
, the news item will appear in the messenger newsfeed without showing a notification badge.
Label names displayed to users to categorize the news item.
Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
curl -i -X PUT \
'https://api.intercom.io/news/news_items/{news_item_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: 2.11' \
-d '{
"title": "Christmas is here!",
"body": "<p>New gifts in store for the jolly season</p>",
"sender_id": 991267745,
"reactions": [
"😝",
"😂"
]
}'
successful
The id of the workspace which the news item belongs to.
The news item body, which may contain HTML.
The id of the sender of the news item. Must be a teammate on the workspace.
News items will not be visible to your users in the assigned newsfeeds until they are set live.
A list of newsfeed_assignments to assign to the specified newsfeed.
Label names displayed to users to categorize the news item.
URL of the image used as cover. Must have .jpg or .png extension.
Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
Timestamp for when the news item was created.
{ "id": "37", "type": "news-item", "workspace_id": "this_is_an_id508_that_should_be_at_least_", "title": "Christmas is here!", "body": "<p>New gifts in store for the jolly season</p>", "sender_id": 991267745, "state": "live", "labels": [], "cover_image_url": null, "reactions": [ "😝", "😂" ], "deliver_silently": false, "created_at": 1719492982, "updated_at": 1719492982, "newsfeed_assignments": [] }
curl -i -X DELETE \
'https://api.intercom.io/news/news_items/{news_item_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
{ "id": "40", "object": "news-item", "deleted": true }
curl -i -X GET \
'https://api.intercom.io/news/newsfeeds/{newsfeed_id}/items' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
successful
Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
An array of News Items
The unique identifier for the news item which is given by Intercom.
The id of the workspace which the news item belongs to.
The news item body, which may contain HTML.
The id of the sender of the news item. Must be a teammate on the workspace.
News items will not be visible to your users in the assigned newsfeeds until they are set live.
A list of newsfeed_assignments to assign to the specified newsfeed.
Label names displayed to users to categorize the news item.
URL of the image used as cover. Must have .jpg or .png extension.
Ordered list of emoji reactions to the news item. When empty, reactions are disabled.
When set to true, the news item will appear in the messenger newsfeed without showing a notification badge.
Timestamp for when the news item was created.
{ "type": "list", "pages": { "page": 1, "per_page": 20, "total_pages": 0, "type": "pages" }, "data": [], "total_count": 0 }
curl -i -X GET \
https://api.intercom.io/news/newsfeeds \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
successful
Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.
An array of Newsfeeds
The unique identifier for the newsfeed which is given by Intercom.
The name of the newsfeed. This name will never be visible to your users.
Timestamp for when the newsfeed was created.
{ "type": "list", "pages": { "page": 1, "per_page": 10, "total_pages": 1, "type": "pages" }, "data": [ { … }, { … } ], "total_count": 2 }
curl -i -X GET \
'https://api.intercom.io/news/newsfeeds/{newsfeed_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
{ "id": "72", "type": "newsfeed", "name": "Visitor Feed", "created_at": 1719492988, "updated_at": 1719492988 }