Home
/
REST API Reference
/
Models
/
Create News Item Request

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

Languages
Servers
The production API server

https://api.intercom.io/

The european API server

https://api.eu.intercom.io/

The australian API server

https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Multiple Filter Search Request

Search with more than one filter.

operatorstring

An operator to allow boolean inspection between multiple fields.

Enum"AND""OR"
Example: "AND"
valueArray of Single Filter Search Request (object) or Multiple Filter Search Request (object)(filter)

Nested filters or queries.

{
  "operator": "AND",
  "value": [
    { … }
  ]
}

Create News Item Request

A News Item is a content type in Intercom enabling you to announce product updates, company news, promotions, events and more with your customers.

titlestringrequired

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.

Example: ["Product","Update","New"]
reactionsArray of strings or null

Ordered list of emoji reactions to the news item. When empty, reactions are disabled.

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

A list of newsfeed_assignments to assign to the specified newsfeed.

{
  "title": "Halloween is here!",
  "body": "<p>New costumes in store for this spooky season</p>",
  "sender_id": 123,
  "state": "live",
  "deliver_silently": true,
  "labels": [
    "Product",
    "Update",
    "New"
  ],
  "reactions": [
    "😆",
    "😅"
  ],
  "newsfeed_assignments": [
    { … }
  ]
}

Paginated Response

A paginated list of notes associated with a contact.

typestringrequired

String representing the object's type. Always has the value list.

Value"list"
Example: "list"
dataArray of objects(Note)required

An array of notes.

data[].​typestringrequired

String representing the object's type. Always has the value note.

Value"note"
Example: "note"
data[].​idstringrequired

The id of the note.

Example: "17495962"
data[].​created_atinteger(timestamp)required

The time the note was created.

Example: 1674589321
data[].​contactobject or nullrequired

Represents the contact that the note was created about.

data[].​contact.​typestring

String representing the object's type. Always has the value contact.

Value"contact"
data[].​contact.​idstring

The id of the contact.

Example: "214656d0c743eafcfde7f248"
data[].​authorobject(Admin)required

Admins are teammate accounts that have access to a workspace.

data[].​author.​typestring

String representing the object's type. Always has the value admin.

Value"admin"
Example: "admin"
data[].​author.​idstringrequired

The id representing the admin.

Example: "1295"
data[].​author.​namestringrequired

The name of the admin.

Example: "Hoban Washburne"
data[].​author.​emailstringrequired

The email of the admin.

Example: "wash@serenity.io"
data[].​author.​job_titlestringrequired

The job title of the admin.

Example: "Philosopher"
data[].​author.​away_mode_enabledbooleanrequired

Identifies if this admin is currently set in away mode.

Example: false
data[].​author.​away_mode_reassignbooleanrequired

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

Example: false
data[].​author.​has_inbox_seatbooleanrequired

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

Example: true
data[].​author.​team_idsArray of integersrequired

This object represents the avatar associated with the admin.

Example: [814865]
data[].​author.​avatarstring or null(uri)

Image for the associated team or teammate

Example: "https://picsum.photos/200/300"
data[].​author.​team_priority_levelobject(Team Priority Level)

Admin priority levels for teams

data[].​bodystringrequired

The body text of the note.

Example: "<p>Text for the note.</p>"
total_countintegerrequired

A count of the total number of notes.

Example: 1
pagesobject(Cursor based pages)

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.

{
  "type": "list",
  "data": [
    { … }
  ],
  "total_count": 1,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  }
}