Skip to content

Document channel.{initial,current} on Conversations API (Preview) #505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hrp merged 2 commits into from
May 20, 2026
+68 −0
Merged

Document channel.{initial,current} on Conversations API (Preview) #505

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c45fef
Document channel.{initial,current} on Conversations API (Preview)
hrp May 19, 2026
bf892cb
Remove redundant Preview qualifier from channel field descriptions
hrp May 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7366,6 +7366,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
schema:
"$ref": "#/components/schemas/conversation_list"
'401':
Expand Down Expand Up @@ -7615,6 +7618,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -7792,6 +7798,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -8040,6 +8049,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -8147,6 +8159,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts: []
Expand Down Expand Up @@ -8485,6 +8500,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
schema:
"$ref": "#/components/schemas/conversation_list"
requestBody:
Expand Down Expand Up @@ -8588,6 +8606,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -8665,6 +8686,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -8754,6 +8778,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -8834,6 +8861,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -9035,6 +9065,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -9112,6 +9145,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -9189,6 +9225,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -9266,6 +9305,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -9975,6 +10017,9 @@ paths:
ai_topics:
ai_agent:
ai_agent_participated: false
channel:
initial: messenger
current: messenger
conversation_parts:
type: conversation_part.list
conversation_parts:
Expand Down Expand Up @@ -21300,6 +21345,10 @@ components:
sales_agent:
"$ref": "#/components/schemas/sales_agent"
nullable: true
channel:
"$ref": "#/components/schemas/conversation_channel"
nullable: true
description: The channel through which the conversation was initiated and its current channel.
conversation:
title: Conversation
type: object
Expand Down Expand Up @@ -21423,6 +21472,10 @@ components:
sales_agent:
"$ref": "#/components/schemas/sales_agent"
nullable: true
channel:
"$ref": "#/components/schemas/conversation_channel"
nullable: true
description: The channel through which the conversation was initiated and its current channel.
conversation_attachment_files:
title: Conversation attachment files
type: object
Expand All @@ -21440,6 +21493,21 @@ components:
type: string
description: The name of the file.
example: test.json
conversation_channel:
title: Conversation Channel
type: object
description: The channel through which a conversation was originally initiated and its current channel.
properties:
initial:
type: string
nullable: true
description: The channel through which the conversation was originally initiated. Possible values include `messenger`, `zendesk_sunshine`, `zendesk_ticket`, `twitter`, `email`. Returns `null` if channel data is unavailable.
example: messenger
current:
type: string
nullable: true
description: The current channel of the conversation. May differ from `initial` if the conversation was migrated between channels. Returns `null` if channel data is unavailable.
example: messenger
conversation_contacts:
title: Contacts
type: object
Expand Down