Home
/
REST API Reference
/
Models
/
Group Content

Intercom API (2.12)

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

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

 

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

 

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

 

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

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 States

Everything about your ticket states

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

File

The value describing a file upload set for a custom attribute

typestring
Example: "upload"
namestring

The name of the file

Example: "Screenshot.png"
urlstring

The url of the file. This is a temporary URL and will expire after 30 minutes.

Example: "https://intercom-attachments-1.com/.../Screenshot.png"
content_typestring

The type of file

Example: "image/png"
filesizeinteger

The size of the file in bytes

Example: 11308309
widthinteger

The width of the file in pixels, if applicable

Example: 3024
heightinteger

The height of the file in pixels, if applicable

Example: 1964
{
  "type": "upload",
  "name": "Screenshot.png",
  "url": "https://intercom-attachments-1.com/.../Screenshot.png",
  "content_type": "image/png",
  "filesize": 11308309,
  "width": 3024,
  "height": 1964
}

Group Content

The Content of a Group.

typestring or null

The type of object - group_content .

Enumnull"group_content"
Example: "group_content"
namestring

The name of the collection or section.

Example: "Collection name"
descriptionstring

The description of the collection. Only available for collections.

Example: " Collection description"
{
  "type": "group_content",
  "name": "Collection name",
  "description": " Collection description"
}

Group Translated Content

The Translated Content of an Group. The keys are the locale codes and the values are the translated content of the Group.

typestring or null

The type of object - group_translated_content.

Enumnull"group_translated_content"
Example: "group_translated_content"
arobject or null(Group Content)

The Content of a Group.

bgobject or null(Group Content)

The Content of a Group.

bsobject or null(Group Content)

The Content of a Group.

caobject or null(Group Content)

The Content of a Group.

csobject or null(Group Content)

The Content of a Group.

daobject or null(Group Content)

The Content of a Group.

deobject or null(Group Content)

The Content of a Group.

elobject or null(Group Content)

The Content of a Group.

enobject or null(Group Content)

The Content of a Group.

esobject or null(Group Content)

The Content of a Group.

etobject or null(Group Content)

The Content of a Group.

fiobject or null(Group Content)

The Content of a Group.

frobject or null(Group Content)

The Content of a Group.

heobject or null(Group Content)

The Content of a Group.

hrobject or null(Group Content)

The Content of a Group.

huobject or null(Group Content)

The Content of a Group.

idobject or null(Group Content)

The Content of a Group.

itobject or null(Group Content)

The Content of a Group.

jaobject or null(Group Content)

The Content of a Group.

koobject or null(Group Content)

The Content of a Group.

ltobject or null(Group Content)

The Content of a Group.

lvobject or null(Group Content)

The Content of a Group.

mnobject or null(Group Content)

The Content of a Group.

nbobject or null(Group Content)

The Content of a Group.

nlobject or null(Group Content)

The Content of a Group.

plobject or null(Group Content)

The Content of a Group.

ptobject or null(Group Content)

The Content of a Group.

roobject or null(Group Content)

The Content of a Group.

ruobject or null(Group Content)

The Content of a Group.

slobject or null(Group Content)

The Content of a Group.

srobject or null(Group Content)

The Content of a Group.

svobject or null(Group Content)

The Content of a Group.

trobject or null(Group Content)

The Content of a Group.

viobject or null(Group Content)

The Content of a Group.

pt-BRobject or null(Group Content)

The Content of a Group.

zh-CNobject or null(Group Content)

The Content of a Group.

zh-TWobject or null(Group Content)

The Content of a Group.

{
  "type": "group_translated_content",
  "ar": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "bg": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "bs": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "ca": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "cs": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "da": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "de": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "el": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "en": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "es": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "et": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "fi": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "fr": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "he": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "hr": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "hu": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "id": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "it": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "ja": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "ko": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "lt": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "lv": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "mn": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "nb": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "nl": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "pl": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "pt": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "ro": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "ru": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "sl": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "sr": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "sv": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "tr": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "vi": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "pt-BR": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "zh-CN": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  },
  "zh-TW": {
    "type": "group_content",
    "name": "Collection name",
    "description": " Collection description"
  }
}