POST /news/news_items
You can create a news item
Servers
- https://api.intercom.io
- https://api.eu.intercom.io
- https://api.au.intercom.io
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Intercom-Version |
String | No |
Possible values:
Default value: "2.12" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
sender_id |
Integer | Yes |
The id of the sender of the news item. Must be a teammate on the workspace. |
labels[] |
Array | No |
Label names displayed to users to categorize the news item. |
deliver_silently |
Boolean | No |
When set to |
title |
String | Yes |
The title of the news item. |
body |
String | No |
The news item body, which may contain HTML. |
state |
String | No |
News items will not be visible to your users in the assigned newsfeeds until they are set live. Possible values:
|
newsfeed_assignments[] |
Array | No |
A list of newsfeed_assignments to assign to the specified newsfeed. |
newsfeed_assignments[].published_at |
Integer | No |
Publish date of the news item on the newsfeed, use this field if you want to set a publish date in the past (e.g. when importing existing news items). On write, this field will be ignored if the news item state is "draft". |
newsfeed_assignments[].newsfeed_id |
Integer | No |
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). |
reactions[] |
Array | No |
Ordered list of emoji reactions to the news item. When empty, reactions are disabled. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.