@@ -9430,6 +9430,89 @@ paths:
94309430 application/json:
94319431 schema:
94329432 "$ref": "#/components/schemas/error"
9433+ "/conversations/{id}/side_conversations":
9434+ get:
9435+ summary: List side conversations
9436+ parameters:
9437+ - name: Intercom-Version
9438+ in: header
9439+ schema:
9440+ "$ref": "#/components/schemas/intercom_version"
9441+ - name: id
9442+ in: path
9443+ required: true
9444+ description: The identifier for the conversation as given by Intercom.
9445+ example: '123'
9446+ schema:
9447+ type: string
9448+ - name: page
9449+ in: query
9450+ required: false
9451+ description: The page number of results to return (starting from 1).
9452+ schema:
9453+ type: integer
9454+ default: 1
9455+ - name: per_page
9456+ in: query
9457+ required: false
9458+ description: The number of side conversations to return per page (max 50).
9459+ schema:
9460+ type: integer
9461+ default: 25
9462+ maximum: 50
9463+ tags:
9464+ - Conversations
9465+ operationId: listSideConversations
9466+ description: |
9467+ List side conversations for a given conversation. Side conversations are internal threads created by teammates from within a conversation.
9468+
9469+ Each side conversation includes its conversation parts (messages). Results are paginated.
9470+
9471+ Requires the `read_conversations` OAuth scope.
9472+ responses:
9473+ '200':
9474+ description: Successful response
9475+ content:
9476+ application/json:
9477+ schema:
9478+ "$ref": "#/components/schemas/side_conversation_list"
9479+ examples:
9480+ Successful response:
9481+ value:
9482+ type: side_conversation.list
9483+ side_conversations:
9484+ - side_conversation_id: '456'
9485+ conversation_parts:
9486+ - type: conversation_part
9487+ id: '789'
9488+ part_type: comment
9489+ body: "<p>Internal note about this issue</p>"
9490+ author:
9491+ type: admin
9492+ id: '123'
9493+ name: Jane Example
9494+ email: jane@example.com
9495+ created_at: 1663597223
9496+ updated_at: 1663597223
9497+ total_count: 1
9498+ total_count: 1
9499+ pages:
9500+ type: pages
9501+ page: 1
9502+ per_page: 25
9503+ total_pages: 1
9504+ '401':
9505+ description: Unauthorized
9506+ content:
9507+ application/json:
9508+ schema:
9509+ "$ref": "#/components/schemas/error"
9510+ '404':
9511+ description: Conversation not found
9512+ content:
9513+ application/json:
9514+ schema:
9515+ "$ref": "#/components/schemas/error"
94339516 "/conversations/redact":
94349517 post:
94359518 summary: Redact a conversation part
@@ -25123,6 +25206,65 @@ components:
2512325206 description: Array of handling events
2512425207 items:
2512525208 "$ref": "#/components/schemas/handling_event"
25209+ side_conversation_summary:
25210+ title: Side Conversation Summary
25211+ type: object
25212+ description: A side conversation with its conversation parts.
25213+ properties:
25214+ side_conversation_id:
25215+ type: string
25216+ description: The unique identifier for the side conversation.
25217+ example: '456'
25218+ conversation_parts:
25219+ type: array
25220+ description: The conversation parts (messages) in this side conversation.
25221+ items:
25222+ "$ref": "#/components/schemas/conversation_part"
25223+ total_count:
25224+ type: integer
25225+ description: The total number of conversation parts in this side conversation.
25226+ example: 1
25227+ side_conversation_list:
25228+ title: Side Conversation List
25229+ type: object
25230+ description: A paginated list of side conversations for a conversation.
25231+ properties:
25232+ type:
25233+ type: string
25234+ description: The type of the response object.
25235+ enum:
25236+ - side_conversation.list
25237+ example: side_conversation.list
25238+ side_conversations:
25239+ type: array
25240+ description: An array of side conversation objects.
25241+ items:
25242+ "$ref": "#/components/schemas/side_conversation_summary"
25243+ total_count:
25244+ type: integer
25245+ description: The total number of side conversations.
25246+ example: 1
25247+ pages:
25248+ type: object
25249+ description: Pagination metadata.
25250+ properties:
25251+ type:
25252+ type: string
25253+ enum:
25254+ - pages
25255+ example: pages
25256+ page:
25257+ type: integer
25258+ description: The current page number.
25259+ example: 1
25260+ per_page:
25261+ type: integer
25262+ description: The number of results per page.
25263+ example: 25
25264+ total_pages:
25265+ type: integer
25266+ description: The total number of pages.
25267+ example: 1
2512625268 help_center:
2512725269 title: Help Center
2512825270 type: object
0 commit comments