Skip to content

Commit c366b1c

Browse files
marcmlcclaude
andauthored
docs: Add conversation_list_item schema for list/search endpoints (#396)
Add a new `conversation_list_item` schema (without `conversation_parts`) for list/search endpoints, keeping the original `conversation` schema completely unchanged. This ensures `GET /conversations/{id}` is not affected while list/search responses no longer misleadingly document `conversation_parts`. Addresses internal ticket 215473350697203. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 10c4328 commit c366b1c

File tree

11 files changed

+1095
-10
lines changed

11 files changed

+1095
-10
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 114 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18544,6 +18544,119 @@ components:
1854418544
description: The content sources used by AI Agent in the conversation.
1854518545
items:
1854618546
"$ref": "#/components/schemas/content_source"
18547+
conversation_list_item:
18548+
title: Conversation List Item
18549+
type: object
18550+
x-tags:
18551+
- Conversations
18552+
description: The data returned about your conversations when you list or search
18553+
them.
18554+
properties:
18555+
type:
18556+
type: string
18557+
description: Always conversation.
18558+
example: conversation
18559+
id:
18560+
type: string
18561+
description: The id representing the conversation.
18562+
example: '1295'
18563+
title:
18564+
type: string
18565+
nullable: true
18566+
description: The title given to the conversation.
18567+
example: Conversation Title
18568+
created_at:
18569+
type: integer
18570+
format: date-time
18571+
description: The time the conversation was created.
18572+
example: 1663597223
18573+
updated_at:
18574+
type: integer
18575+
format: date-time
18576+
description: The last time the conversation was updated.
18577+
example: 1663597260
18578+
waiting_since:
18579+
type: integer
18580+
format: date-time
18581+
nullable: true
18582+
description: The last time a Contact responded to an Admin. In other words,
18583+
the time a customer started waiting for a response. Set to null if last
18584+
reply is from an Admin.
18585+
example: 1663597260
18586+
snoozed_until:
18587+
type: integer
18588+
format: date-time
18589+
nullable: true
18590+
description: If set this is the time in the future when this conversation
18591+
will be marked as open. i.e. it will be in a snoozed state until this
18592+
time. i.e. it will be in a snoozed state until this time.
18593+
example: 1663597260
18594+
open:
18595+
type: boolean
18596+
description: Indicates whether a conversation is open (true) or closed (false).
18597+
example: true
18598+
state:
18599+
type: string
18600+
enum:
18601+
- open
18602+
- closed
18603+
- snoozed
18604+
description: Can be set to "open", "closed" or "snoozed".
18605+
example: open
18606+
read:
18607+
type: boolean
18608+
description: Indicates whether a conversation has been read.
18609+
example: true
18610+
priority:
18611+
type: string
18612+
enum:
18613+
- priority
18614+
- not_priority
18615+
description: If marked as priority, it will return priority or else not_priority.
18616+
example: priority
18617+
admin_assignee_id:
18618+
type: integer
18619+
nullable: true
18620+
description: The id of the admin assigned to the conversation. If it's not
18621+
assigned to an admin it will return null.
18622+
example: 0
18623+
team_assignee_id:
18624+
type: string
18625+
nullable: true
18626+
description: The id of the team assigned to the conversation. If it's not
18627+
assigned to a team it will return null.
18628+
example: '5017691'
18629+
company:
18630+
"$ref": "#/components/schemas/company"
18631+
nullable: true
18632+
description: The company associated with the conversation.
18633+
tags:
18634+
"$ref": "#/components/schemas/tags"
18635+
conversation_rating:
18636+
"$ref": "#/components/schemas/conversation_rating"
18637+
source:
18638+
"$ref": "#/components/schemas/conversation_source"
18639+
contacts:
18640+
"$ref": "#/components/schemas/conversation_contacts"
18641+
teammates:
18642+
"$ref": "#/components/schemas/conversation_teammates"
18643+
custom_attributes:
18644+
"$ref": "#/components/schemas/custom_attributes"
18645+
first_contact_reply:
18646+
"$ref": "#/components/schemas/conversation_first_contact_reply"
18647+
sla_applied:
18648+
"$ref": "#/components/schemas/sla_applied"
18649+
statistics:
18650+
"$ref": "#/components/schemas/conversation_statistics"
18651+
linked_objects:
18652+
"$ref": "#/components/schemas/linked_object_list"
18653+
ai_agent_participated:
18654+
type: boolean
18655+
description: Indicates whether the AI Agent participated in the conversation.
18656+
example: true
18657+
ai_agent:
18658+
"$ref": "#/components/schemas/ai_agent"
18659+
nullable: true
1854718660
conversation:
1854818661
title: Conversation
1854918662
type: object
@@ -18754,7 +18867,7 @@ components:
1875418867
type: array
1875518868
description: The list of conversation objects
1875618869
items:
18757-
"$ref": "#/components/schemas/conversation"
18870+
"$ref": "#/components/schemas/conversation_list_item"
1875818871
total_count:
1875918872
type: integer
1876018873
description: A count of the total number of objects.

descriptions/2.10/api.intercom.io.yaml

Lines changed: 101 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12885,6 +12885,106 @@ components:
1288512885
type: boolean
1288612886
description: Whether the contact is archived or not.
1288712887
example: false
12888+
conversation_list_item:
12889+
title: Conversation List Item
12890+
type: object
12891+
x-tags:
12892+
- Conversations
12893+
description: The data returned about your conversations when you list or search
12894+
them.
12895+
properties:
12896+
type:
12897+
type: string
12898+
description: Always conversation.
12899+
example: conversation
12900+
id:
12901+
type: string
12902+
description: The id representing the conversation.
12903+
example: '1295'
12904+
title:
12905+
type: string
12906+
nullable: true
12907+
description: The title given to the conversation.
12908+
example: Conversation Title
12909+
created_at:
12910+
type: integer
12911+
format: date-time
12912+
description: The time the conversation was created.
12913+
example: 1663597223
12914+
updated_at:
12915+
type: integer
12916+
format: date-time
12917+
description: The last time the conversation was updated.
12918+
example: 1663597260
12919+
waiting_since:
12920+
type: integer
12921+
format: date-time
12922+
nullable: true
12923+
description: The last time a Contact responded to an Admin. In other words,
12924+
the time a customer started waiting for a response. Set to null if last
12925+
reply is from an Admin.
12926+
example: 1663597260
12927+
snoozed_until:
12928+
type: integer
12929+
format: date-time
12930+
nullable: true
12931+
description: If set this is the time in the future when this conversation
12932+
will be marked as open. i.e. it will be in a snoozed state until this
12933+
time. i.e. it will be in a snoozed state until this time.
12934+
example: 1663597260
12935+
open:
12936+
type: boolean
12937+
description: Indicates whether a conversation is open (true) or closed (false).
12938+
example: true
12939+
state:
12940+
type: string
12941+
enum:
12942+
- open
12943+
- closed
12944+
- snoozed
12945+
description: Can be set to "open", "closed" or "snoozed".
12946+
example: open
12947+
read:
12948+
type: boolean
12949+
description: Indicates whether a conversation has been read.
12950+
example: true
12951+
priority:
12952+
type: string
12953+
enum:
12954+
- priority
12955+
- not_priority
12956+
description: If marked as priority, it will return priority or else not_priority.
12957+
example: priority
12958+
admin_assignee_id:
12959+
type: integer
12960+
nullable: true
12961+
description: The id of the admin assigned to the conversation. If it's not
12962+
assigned to an admin it will return null.
12963+
example: 0
12964+
team_assignee_id:
12965+
type: string
12966+
nullable: true
12967+
description: The id of the team assigned to the conversation. If it's not
12968+
assigned to a team it will return null.
12969+
example: '5017691'
12970+
tags:
12971+
"$ref": "#/components/schemas/tags"
12972+
conversation_rating:
12973+
"$ref": "#/components/schemas/conversation_rating"
12974+
source:
12975+
"$ref": "#/components/schemas/conversation_source"
12976+
contacts:
12977+
"$ref": "#/components/schemas/conversation_contacts"
12978+
teammates:
12979+
"$ref": "#/components/schemas/conversation_teammates"
12980+
first_contact_reply:
12981+
"$ref": "#/components/schemas/conversation_first_contact_reply"
12982+
sla_applied:
12983+
"$ref": "#/components/schemas/sla_applied"
12984+
statistics:
12985+
"$ref": "#/components/schemas/conversation_statistics"
12986+
linked_objects:
12987+
"$ref": "#/components/schemas/linked_object_list"
1288812988
conversation:
1288912989
title: Conversation
1289012990
type: object
@@ -13063,7 +13163,7 @@ components:
1306313163
type: array
1306413164
description: The list of conversation objects
1306513165
items:
13066-
"$ref": "#/components/schemas/conversation"
13166+
"$ref": "#/components/schemas/conversation_list_item"
1306713167
total_count:
1306813168
type: integer
1306913169
description: A count of the total number of objects.

descriptions/2.11/api.intercom.io.yaml

Lines changed: 130 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13588,6 +13588,135 @@ components:
1358813588
type: string
1358913589
description: The current page URL where the app is being used.
1359013590
example: "https://example.com/page"
13591+
conversation_list_item:
13592+
title: Conversation List Item
13593+
type: object
13594+
x-tags:
13595+
- Conversations
13596+
description: The data returned about your conversations when you list or search
13597+
them.
13598+
required:
13599+
- id
13600+
- created_at
13601+
- updated_at
13602+
- source
13603+
- contacts
13604+
- teammates
13605+
- title
13606+
- admin_assignee_id
13607+
- team_assignee_id
13608+
- custom_attributes
13609+
- topics
13610+
- open
13611+
- state
13612+
- read
13613+
- waiting_since
13614+
- snoozed_until
13615+
properties:
13616+
type:
13617+
type: string
13618+
description: Always conversation.
13619+
example: conversation
13620+
enum:
13621+
- conversation
13622+
id:
13623+
type: string
13624+
description: The id representing the conversation.
13625+
example: '1295'
13626+
title:
13627+
type: string
13628+
nullable: true
13629+
description: The title given to the conversation.
13630+
example: Conversation Title
13631+
created_at:
13632+
type: integer
13633+
format: date-time
13634+
description: The time the conversation was created.
13635+
example: 1663597223
13636+
updated_at:
13637+
type: integer
13638+
format: date-time
13639+
description: The last time the conversation was updated.
13640+
example: 1663597260
13641+
waiting_since:
13642+
type: integer
13643+
format: date-time
13644+
nullable: true
13645+
description: The last time a Contact responded to an Admin. In other words,
13646+
the time a customer started waiting for a response. Set to null if last
13647+
reply is from an Admin.
13648+
example: 1663597260
13649+
snoozed_until:
13650+
type: integer
13651+
format: date-time
13652+
nullable: true
13653+
description: If set this is the time in the future when this conversation
13654+
will be marked as open. i.e. it will be in a snoozed state until this
13655+
time. i.e. it will be in a snoozed state until this time.
13656+
example: 1663597260
13657+
open:
13658+
type: boolean
13659+
description: Indicates whether a conversation is open (true) or closed (false).
13660+
example: true
13661+
state:
13662+
type: string
13663+
enum:
13664+
- open
13665+
- closed
13666+
- snoozed
13667+
description: Can be set to "open", "closed" or "snoozed".
13668+
example: open
13669+
read:
13670+
type: boolean
13671+
description: Indicates whether a conversation has been read.
13672+
example: true
13673+
priority:
13674+
type: string
13675+
enum:
13676+
- priority
13677+
- not_priority
13678+
description: If marked as priority, it will return priority or else not_priority.
13679+
example: priority
13680+
admin_assignee_id:
13681+
type: integer
13682+
nullable: true
13683+
description: The id of the admin assigned to the conversation. If it's not
13684+
assigned to an admin it will return null.
13685+
example: 0
13686+
team_assignee_id:
13687+
type: string
13688+
nullable: true
13689+
description: The id of the team assigned to the conversation. If it's not
13690+
assigned to a team it will return null.
13691+
example: '5017691'
13692+
tags:
13693+
"$ref": "#/components/schemas/tags"
13694+
conversation_rating:
13695+
"$ref": "#/components/schemas/conversation_rating"
13696+
source:
13697+
"$ref": "#/components/schemas/conversation_source"
13698+
contacts:
13699+
"$ref": "#/components/schemas/conversation_contacts"
13700+
teammates:
13701+
"$ref": "#/components/schemas/conversation_teammates"
13702+
custom_attributes:
13703+
"$ref": "#/components/schemas/custom_attributes"
13704+
first_contact_reply:
13705+
"$ref": "#/components/schemas/conversation_first_contact_reply"
13706+
sla_applied:
13707+
"$ref": "#/components/schemas/sla_applied"
13708+
nullable: true
13709+
statistics:
13710+
"$ref": "#/components/schemas/conversation_statistics"
13711+
linked_objects:
13712+
"$ref": "#/components/schemas/linked_object_list"
13713+
ai_agent_participated:
13714+
type: boolean
13715+
description: Indicates whether the AI Agent participated in the conversation.
13716+
example: true
13717+
ai_agent:
13718+
"$ref": "#/components/schemas/ai_agent"
13719+
nullable: true
1359113720
conversation:
1359213721
title: Conversation
1359313722
type: object
@@ -13803,7 +13932,7 @@ components:
1380313932
type: array
1380413933
description: The list of conversation objects
1380513934
items:
13806-
"$ref": "#/components/schemas/conversation"
13935+
"$ref": "#/components/schemas/conversation_list_item"
1380713936
total_count:
1380813937
type: integer
1380913938
description: A count of the total number of objects.

0 commit comments

Comments
 (0)