Conversation part author

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.",

Conversation Part

A Conversation Part represents a message in the conversation.

typestring

Always conversation_part

Example: "conversation_part"

idstring

The id representing the conversation part.

Example: "3"

part_typestring

The type of conversation part.

Example: "comment"

bodystring or null

The message body, which may contain HTML. For Twitter, this will show a generic message regarding why the body is obscured.

Example: "<p>Okay!</p>"

created_atinteger(date-time)

The time the conversation part was created.

Example: 1663597223

updated_atinteger(date-time)

The last time the conversation part was updated.

Example: 1663597260

notified_atinteger(date-time)

The time the user was notified with the conversation part.

Example: 1663597260

assigned_toobject(Reference)

reference to another object

authorobject(Conversation part author)

The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.

attachmentsArray of objects(Conversation part attachments)

A list of attachments for the part.

external_idstring or null

The external id of the conversation part

Example: "abcd1234"

redactedboolean

Whether or not the conversation part has been redacted.

Example: false

email_message_metadataobject(Email Message Metadata)

Contains metadata if the message was sent as an email

statestring

Indicates the current state of conversation when the conversation part was created.

Enum"open""closed""snoozed"

Example: "open"

tagsArray of objects or null(Tag)

A list of tags objects associated with the conversation part.

event_detailsPart type - conversation_attribute_updated_by_workflow (object) or Part type - conversation_attribute_updated_by_admin (object) or Part type - custom_action_started (object) or Part type - custom_action_finished (object) or Part type - operator_workflow_event (object)(Event details of Workflow & actions)

Any of:

Contains details about the workflow that was triggered and any Custom Data Attributes (CDAs) that were modified during the workflow execution for conversation part type conversation_attribute_updated_by_workflow.

app_package_codestring or null

The app package code if this part was created via API. null if the part was not created via API.

Example: "test-integration"

{
  "type": "conversation_part",
  "id": "3",
  "part_type": "comment",
  "body": "<p>Okay!</p>",
  "created_at": 1663597223,
  "updated_at": 1663597260,
  "notified_at": 1663597260,
  "assigned_to": {
    "type": "contact",
    "id": "1a2b3c"
  },
  "author": {
    "type": "admin",
    "id": "274",
    "name": "Operator",
    "email": "operator+abcd1234@intercom.io"
  },
  "attachments": [
    { … }
  ],
  "external_id": "abcd1234",
  "redacted": false,
  "email_message_metadata": {
    "subject": "Question about my order",
    "email_address_headers": [ … ]
  },
  "state": "open",
  "tags": [
    { … }
  ],
  "event_details": {
    "workflow": { … },
    "attribute": { … },
    "value": { … }
  },
  "app_package_code": "test-integration"
}

Conversation part author

The object who initiated the conversation, which can be a Contact, Admin or Team. Bots and campaigns send messages on behalf of Admins or Teams. For Twitter, this will be blank.

typestring

The type of the author

Example: "admin"

idstring

The id of the author

Example: "274"

namestring

The name of the author

Example: "Operator"

emailstring(email)

The email of the author

Example: "operator+abcd1234@intercom.io"

{
  "type": "admin",
  "id": "274",
  "name": "Operator",
  "email": "operator+abcd1234@intercom.io"
}

Conversation Parts

A list of Conversation Part objects for each part message in the conversation. This is only returned when Retrieving a Conversation, and ignored when Listing all Conversations. There is a limit of 500 parts.

typestring

Value"conversation_part.list"

Example: "conversation_part.list"

conversation_partsArray of objects(Conversation Parts)

total_countinteger

Example: 2

{
  "type": "conversation_part.list",
  "conversation_parts": [
    { … }
  ],
  "total_count": 2
}

Intercom API (2.13)

Admins

AI Content

Articles

Companies

Contacts

Conversations

Custom Object Instances

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket States

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models