Skip to content

Commit fc036ba

Browse files
marcmlcclaude
andcommitted
docs: Apply conversation schema split to all API versions
Extend the conversation_list_item / conversation schema split to versions 0, 2.7–2.14 so list/search endpoints no longer show conversation_parts in their response documentation across all versions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent aa7be3a commit fc036ba

9 files changed

Lines changed: 174 additions & 102 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18532,14 +18532,13 @@ components:
1853218532
description: The content sources used by AI Agent in the conversation.
1853318533
items:
1853418534
"$ref": "#/components/schemas/content_source"
18535-
conversation:
18536-
title: Conversation
18535+
conversation_list_item:
18536+
title: Conversation List Item
1853718537
type: object
1853818538
x-tags:
1853918539
- Conversations
18540-
description: Conversations are how you can communicate with users in Intercom.
18541-
They are created when a contact replies to an outbound message, or when one
18542-
admin directly sends a message to a single contact.
18540+
description: The data returned about your conversations when you list or search
18541+
them.
1854318542
properties:
1854418543
type:
1854518544
type: string
@@ -18637,8 +18636,6 @@ components:
1863718636
"$ref": "#/components/schemas/sla_applied"
1863818637
statistics:
1863918638
"$ref": "#/components/schemas/conversation_statistics"
18640-
conversation_parts:
18641-
"$ref": "#/components/schemas/conversation_parts"
1864218639
linked_objects:
1864318640
"$ref": "#/components/schemas/linked_object_list"
1864418641
ai_agent_participated:
@@ -18648,6 +18645,19 @@ components:
1864818645
ai_agent:
1864918646
"$ref": "#/components/schemas/ai_agent"
1865018647
nullable: true
18648+
conversation:
18649+
title: Conversation
18650+
type: object
18651+
x-tags:
18652+
- Conversations
18653+
description: Conversations are how you can communicate with users in Intercom.
18654+
They are created when a contact replies to an outbound message, or when one
18655+
admin directly sends a message to a single contact.
18656+
properties:
18657+
conversation_parts:
18658+
"$ref": "#/components/schemas/conversation_parts"
18659+
allOf:
18660+
- "$ref": "#/components/schemas/conversation_list_item"
1865118661
conversation_attachment_files:
1865218662
title: Conversation attachment files
1865318663
type: object
@@ -18742,7 +18752,7 @@ components:
1874218752
type: array
1874318753
description: The list of conversation objects
1874418754
items:
18745-
"$ref": "#/components/schemas/conversation"
18755+
"$ref": "#/components/schemas/conversation_list_item"
1874618756
total_count:
1874718757
type: integer
1874818758
description: A count of the total number of objects.
@@ -18874,8 +18884,7 @@ components:
1887418884
title: Conversation Parts
1887518885
type: object
1887618886
description: A list of Conversation Part objects for each part message in the
18877-
conversation. This is only returned when Retrieving a Conversation, and ignored
18878-
when Listing all Conversations. There is a limit of 500 parts.
18887+
conversation. There is a limit of 500 parts.
1887918888
properties:
1888018889
type:
1888118890
type: string
@@ -18887,8 +18896,7 @@ components:
1888718896
title: Conversation Parts
1888818897
type: array
1888918898
description: A list of Conversation Part objects for each part message in
18890-
the conversation. This is only returned when Retrieving a Conversation,
18891-
and ignored when Listing all Conversations. There is a limit of 500 parts.
18899+
the conversation. There is a limit of 500 parts.
1889218900
items:
1889318901
"$ref": "#/components/schemas/conversation_part"
1889418902
total_count:

descriptions/2.10/api.intercom.io.yaml

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12885,14 +12885,13 @@ components:
1288512885
type: boolean
1288612886
description: Whether the contact is archived or not.
1288712887
example: false
12888-
conversation:
12889-
title: Conversation
12888+
conversation_list_item:
12889+
title: Conversation List Item
1289012890
type: object
1289112891
x-tags:
1289212892
- Conversations
12893-
description: Conversations are how you can communicate with users in Intercom.
12894-
They are created when a contact replies to an outbound message, or when one
12895-
admin directly sends a message to a single contact.
12893+
description: The data returned about your conversations when you list or search
12894+
them.
1289612895
properties:
1289712896
type:
1289812897
type: string
@@ -12984,10 +12983,21 @@ components:
1298412983
"$ref": "#/components/schemas/sla_applied"
1298512984
statistics:
1298612985
"$ref": "#/components/schemas/conversation_statistics"
12987-
conversation_parts:
12988-
"$ref": "#/components/schemas/conversation_parts"
1298912986
linked_objects:
1299012987
"$ref": "#/components/schemas/linked_object_list"
12988+
conversation:
12989+
title: Conversation
12990+
type: object
12991+
x-tags:
12992+
- Conversations
12993+
description: Conversations are how you can communicate with users in Intercom.
12994+
They are created when a contact replies to an outbound message, or when one
12995+
admin directly sends a message to a single contact.
12996+
properties:
12997+
conversation_parts:
12998+
"$ref": "#/components/schemas/conversation_parts"
12999+
allOf:
13000+
- "$ref": "#/components/schemas/conversation_list_item"
1299113001
conversation_attachment_files:
1299213002
title: Conversation attachment files
1299313003
type: object
@@ -13063,7 +13073,7 @@ components:
1306313073
type: array
1306413074
description: The list of conversation objects
1306513075
items:
13066-
"$ref": "#/components/schemas/conversation"
13076+
"$ref": "#/components/schemas/conversation_list_item"
1306713077
total_count:
1306813078
type: integer
1306913079
description: A count of the total number of objects.
@@ -13159,8 +13169,7 @@ components:
1315913169
title: Conversation Parts
1316013170
type: object
1316113171
description: A list of Conversation Part objects for each part message in the
13162-
conversation. This is only returned when Retrieving a Conversation, and ignored
13163-
when Listing all Conversations. There is a limit of 500 parts.
13172+
conversation. There is a limit of 500 parts.
1316413173
properties:
1316513174
type:
1316613175
type: string
@@ -13172,8 +13181,7 @@ components:
1317213181
title: Conversation Parts
1317313182
type: array
1317413183
description: A list of Conversation Part objects for each part message in
13175-
the conversation. This is only returned when Retrieving a Conversation,
13176-
and ignored when Listing all Conversations. There is a limit of 500 parts.
13184+
the conversation. There is a limit of 500 parts.
1317713185
items:
1317813186
"$ref": "#/components/schemas/conversation_part"
1317913187
total_count:

descriptions/2.11/api.intercom.io.yaml

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13588,14 +13588,13 @@ components:
1358813588
type: string
1358913589
description: The current page URL where the app is being used.
1359013590
example: "https://example.com/page"
13591-
conversation:
13592-
title: Conversation
13591+
conversation_list_item:
13592+
title: Conversation List Item
1359313593
type: object
1359413594
x-tags:
1359513595
- Conversations
13596-
description: Conversations are how you can communicate with users in Intercom.
13597-
They are created when a contact replies to an outbound message, or when one
13598-
admin directly sends a message to a single contact.
13596+
description: The data returned about your conversations when you list or search
13597+
them.
1359913598
required:
1360013599
- id
1360113600
- created_at
@@ -13709,8 +13708,6 @@ components:
1370913708
nullable: true
1371013709
statistics:
1371113710
"$ref": "#/components/schemas/conversation_statistics"
13712-
conversation_parts:
13713-
"$ref": "#/components/schemas/conversation_parts"
1371413711
linked_objects:
1371513712
"$ref": "#/components/schemas/linked_object_list"
1371613713
ai_agent_participated:
@@ -13720,6 +13717,19 @@ components:
1372013717
ai_agent:
1372113718
"$ref": "#/components/schemas/ai_agent"
1372213719
nullable: true
13720+
conversation:
13721+
title: Conversation
13722+
type: object
13723+
x-tags:
13724+
- Conversations
13725+
description: Conversations are how you can communicate with users in Intercom.
13726+
They are created when a contact replies to an outbound message, or when one
13727+
admin directly sends a message to a single contact.
13728+
properties:
13729+
conversation_parts:
13730+
"$ref": "#/components/schemas/conversation_parts"
13731+
allOf:
13732+
- "$ref": "#/components/schemas/conversation_list_item"
1372313733
conversation_attachment_files:
1372413734
title: Conversation attachment files
1372513735
type: object
@@ -13803,7 +13813,7 @@ components:
1380313813
type: array
1380413814
description: The list of conversation objects
1380513815
items:
13806-
"$ref": "#/components/schemas/conversation"
13816+
"$ref": "#/components/schemas/conversation_list_item"
1380713817
total_count:
1380813818
type: integer
1380913819
description: A count of the total number of objects.
@@ -13918,8 +13928,7 @@ components:
1391813928
title: Conversation Parts
1391913929
type: object
1392013930
description: A list of Conversation Part objects for each part message in the
13921-
conversation. This is only returned when Retrieving a Conversation, and ignored
13922-
when Listing all Conversations. There is a limit of 500 parts.
13931+
conversation. There is a limit of 500 parts.
1392313932
properties:
1392413933
type:
1392513934
type: string
@@ -13931,8 +13940,7 @@ components:
1393113940
title: Conversation Parts
1393213941
type: array
1393313942
description: A list of Conversation Part objects for each part message in
13934-
the conversation. This is only returned when Retrieving a Conversation,
13935-
and ignored when Listing all Conversations. There is a limit of 500 parts.
13943+
the conversation. There is a limit of 500 parts.
1393613944
items:
1393713945
"$ref": "#/components/schemas/conversation_part"
1393813946
total_count:

descriptions/2.12/api.intercom.io.yaml

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13919,14 +13919,13 @@ components:
1391913919
description: The content sources used by AI Agent in the conversation.
1392013920
items:
1392113921
"$ref": "#/components/schemas/content_source"
13922-
conversation:
13923-
title: Conversation
13922+
conversation_list_item:
13923+
title: Conversation List Item
1392413924
type: object
1392513925
x-tags:
1392613926
- Conversations
13927-
description: Conversations are how you can communicate with users in Intercom.
13928-
They are created when a contact replies to an outbound message, or when one
13929-
admin directly sends a message to a single contact.
13927+
description: The data returned about your conversations when you list or search
13928+
them.
1393013929
properties:
1393113930
type:
1393213931
type: string
@@ -14018,8 +14017,6 @@ components:
1401814017
"$ref": "#/components/schemas/sla_applied"
1401914018
statistics:
1402014019
"$ref": "#/components/schemas/conversation_statistics"
14021-
conversation_parts:
14022-
"$ref": "#/components/schemas/conversation_parts"
1402314020
linked_objects:
1402414021
"$ref": "#/components/schemas/linked_object_list"
1402514022
ai_agent_participated:
@@ -14029,6 +14026,19 @@ components:
1402914026
ai_agent:
1403014027
"$ref": "#/components/schemas/ai_agent"
1403114028
nullable: true
14029+
conversation:
14030+
title: Conversation
14031+
type: object
14032+
x-tags:
14033+
- Conversations
14034+
description: Conversations are how you can communicate with users in Intercom.
14035+
They are created when a contact replies to an outbound message, or when one
14036+
admin directly sends a message to a single contact.
14037+
properties:
14038+
conversation_parts:
14039+
"$ref": "#/components/schemas/conversation_parts"
14040+
allOf:
14041+
- "$ref": "#/components/schemas/conversation_list_item"
1403214042
conversation_attachment_files:
1403314043
title: Conversation attachment files
1403414044
type: object
@@ -14104,7 +14114,7 @@ components:
1410414114
type: array
1410514115
description: The list of conversation objects
1410614116
items:
14107-
"$ref": "#/components/schemas/conversation"
14117+
"$ref": "#/components/schemas/conversation_list_item"
1410814118
total_count:
1410914119
type: integer
1411014120
description: A count of the total number of objects.
@@ -14200,8 +14210,7 @@ components:
1420014210
title: Conversation Parts
1420114211
type: object
1420214212
description: A list of Conversation Part objects for each part message in the
14203-
conversation. This is only returned when Retrieving a Conversation, and ignored
14204-
when Listing all Conversations. There is a limit of 500 parts.
14213+
conversation. There is a limit of 500 parts.
1420514214
properties:
1420614215
type:
1420714216
type: string
@@ -14213,8 +14222,7 @@ components:
1421314222
title: Conversation Parts
1421414223
type: array
1421514224
description: A list of Conversation Part objects for each part message in
14216-
the conversation. This is only returned when Retrieving a Conversation,
14217-
and ignored when Listing all Conversations. There is a limit of 500 parts.
14225+
the conversation. There is a limit of 500 parts.
1421814226
items:
1421914227
"$ref": "#/components/schemas/conversation_part"
1422014228
total_count:

descriptions/2.13/api.intercom.io.yaml

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15288,14 +15288,13 @@ components:
1528815288
description: The content sources used by AI Agent in the conversation.
1528915289
items:
1529015290
"$ref": "#/components/schemas/content_source"
15291-
conversation:
15292-
title: Conversation
15291+
conversation_list_item:
15292+
title: Conversation List Item
1529315293
type: object
1529415294
x-tags:
1529515295
- Conversations
15296-
description: Conversations are how you can communicate with users in Intercom.
15297-
They are created when a contact replies to an outbound message, or when one
15298-
admin directly sends a message to a single contact.
15296+
description: The data returned about your conversations when you list or search
15297+
them.
1529915298
properties:
1530015299
type:
1530115300
type: string
@@ -15387,8 +15386,6 @@ components:
1538715386
"$ref": "#/components/schemas/sla_applied"
1538815387
statistics:
1538915388
"$ref": "#/components/schemas/conversation_statistics"
15390-
conversation_parts:
15391-
"$ref": "#/components/schemas/conversation_parts"
1539215389
linked_objects:
1539315390
"$ref": "#/components/schemas/linked_object_list"
1539415391
ai_agent_participated:
@@ -15398,6 +15395,19 @@ components:
1539815395
ai_agent:
1539915396
"$ref": "#/components/schemas/ai_agent"
1540015397
nullable: true
15398+
conversation:
15399+
title: Conversation
15400+
type: object
15401+
x-tags:
15402+
- Conversations
15403+
description: Conversations are how you can communicate with users in Intercom.
15404+
They are created when a contact replies to an outbound message, or when one
15405+
admin directly sends a message to a single contact.
15406+
properties:
15407+
conversation_parts:
15408+
"$ref": "#/components/schemas/conversation_parts"
15409+
allOf:
15410+
- "$ref": "#/components/schemas/conversation_list_item"
1540115411
conversation_attachment_files:
1540215412
title: Conversation attachment files
1540315413
type: object
@@ -15492,7 +15502,7 @@ components:
1549215502
type: array
1549315503
description: The list of conversation objects
1549415504
items:
15495-
"$ref": "#/components/schemas/conversation"
15505+
"$ref": "#/components/schemas/conversation_list_item"
1549615506
total_count:
1549715507
type: integer
1549815508
description: A count of the total number of objects.
@@ -15613,8 +15623,7 @@ components:
1561315623
title: Conversation Parts
1561415624
type: object
1561515625
description: A list of Conversation Part objects for each part message in the
15616-
conversation. This is only returned when Retrieving a Conversation, and ignored
15617-
when Listing all Conversations. There is a limit of 500 parts.
15626+
conversation. There is a limit of 500 parts.
1561815627
properties:
1561915628
type:
1562015629
type: string
@@ -15626,8 +15635,7 @@ components:
1562615635
title: Conversation Parts
1562715636
type: array
1562815637
description: A list of Conversation Part objects for each part message in
15629-
the conversation. This is only returned when Retrieving a Conversation,
15630-
and ignored when Listing all Conversations. There is a limit of 500 parts.
15638+
the conversation. There is a limit of 500 parts.
1563115639
items:
1563215640
"$ref": "#/components/schemas/conversation_part"
1563315641
total_count:

0 commit comments

Comments
 (0)