Skip to content
Home/
REST API Reference
/
/
Part attachment

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

SchemasOperations

Articles

Everything about your Articles

SchemasOperations

Companies

Everything about your Companies

SchemasOperations

Contacts

Everything about your contacts

SchemasOperations

Conversations

Everything about your Conversations

SchemasOperations

Data Attributes

Everything about your Data Attributes

SchemasOperations

Data Events

Everything about your Data Events

SchemasOperations

Data Export

Everything about your Data Exports

SchemasOperations

Help Center

Everything about your Help Center

SchemasOperations

Messages

Everything about your messages

SchemasOperations

News

Everything about your News

SchemasOperations

Notes

Everything about your Notes

SchemasOperations

Segments

Everything about your Segments

SchemasOperations

Subscription Types

Everything about subscription types

SchemasOperations

Switch

Everything about Switch

Operations

Tags

Everything about tags

SchemasOperations

Teams

Everything about your Teams

SchemasOperations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

SchemasOperations

Visitors

Everything about your Visitors

Operations

Models

Schemas

Paginated Newsfeed Response

Paginated Newsfeed Response

typestringrequired

The type of object

Value"list"
Example: "list"
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.

total_countintegerrequired

A count of the total number of Newsfeeds.

Example: 1
dataArray of objects(Newsfeed)required

An array of Newsfeeds

data[].​idstringrequired

The unique identifier for the newsfeed which is given by Intercom.

Example: "12312"
data[].​typestringrequired

The type of object.

Value"newsfeed"
Example: "newsfeed"
data[].​namestringrequired

The name of the newsfeed. This name will never be visible to your users.

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

Timestamp for when the newsfeed was created.

Example: 1674917488
data[].​updated_atinteger(timestamp)

Timestamp for when the newsfeed was last updated.

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

Part attachment

The file attached to a part

typestringrequired

The type of attachment

Example: "upload"
namestringrequired

The name of the attachment

Example: "example.png"
urlstringrequired

The URL of the attachment

Example: "https://picsum.photos/200/300"
content_typestringrequired

The content type of the attachment

Example: "image/png"
filesizeintegerrequired

The size of the attachment

Example: 100
widthintegerrequired

The width of the attachment

Example: 100
heightintegerrequired

The height of the attachment

Example: 100
{
  "type": "upload",
  "name": "example.png",
  "url": "https://picsum.photos/200/300",
  "content_type": "image/png",
  "filesize": 100,
  "width": 100,
  "height": 100
}

Phone Switch

Phone Switch Response

typestringrequired
Default "phone_call_redirect"
Value"phone_call_redirect"
Example: "phone_call_redirect"
phonestringrequired

Phone number in E.164 format, that has received the SMS to continue the conversation in the Messenger.

Example: "+1 1234567890"
{
  "type": "phone_call_redirect",
  "phone": "+1 1234567890"
}