Skip to content

Commit 8e29306

Browse files
salmanbshahclaude
andauthored
Document PUT /conversations/{id}/conversation_parts/{id} - missing endpoint (#406)
Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
1 parent 35a19b9 commit 8e29306

1 file changed

Lines changed: 174 additions & 0 deletions

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 174 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8465,6 +8465,144 @@ paths:
84658465
type: admin
84668466
admin_id: 991267717
84678467
body: Goodbye :)
8468+
"/conversations/{conversation_id}/conversation_parts/{id}":
8469+
put:
8470+
summary: Update a conversation part
8471+
parameters:
8472+
- name: Intercom-Version
8473+
in: header
8474+
schema:
8475+
"$ref": "#/components/schemas/intercom_version"
8476+
- name: conversation_id
8477+
in: path
8478+
required: true
8479+
description: The identifier for the conversation as given by Intercom.
8480+
example: '123'
8481+
schema:
8482+
type: string
8483+
- name: id
8484+
in: path
8485+
required: true
8486+
description: The identifier for the conversation part.
8487+
example: '456'
8488+
schema:
8489+
type: string
8490+
tags:
8491+
- Conversations
8492+
operationId: updateConversationPart
8493+
description: |
8494+
You can update properties of a conversation part. Currently supports updating the send state of an external reply or marking a part as seen by an admin.
8495+
8496+
{% admonition type="warning" name="Experimental" %}
8497+
This is an experimental endpoint. It requires a valid HMAC secret for authentication in addition to the standard bearer token.
8498+
{% /admonition %}
8499+
responses:
8500+
'200':
8501+
description: Conversation part updated
8502+
content:
8503+
application/json:
8504+
examples:
8505+
Update send state:
8506+
value:
8507+
type: conversation_part
8508+
id: '456'
8509+
part_type: comment
8510+
body: "<p>Hello there!</p>"
8511+
created_at: 1734537559
8512+
updated_at: 1734537561
8513+
notified_at: 1734537559
8514+
assigned_to:
8515+
author:
8516+
id: '991267694'
8517+
type: admin
8518+
name: Ciaran Lee
8519+
email: admin@email.com
8520+
attachments: []
8521+
external_id:
8522+
external_reply_send_state: sent
8523+
Mark part as seen:
8524+
value:
8525+
type: conversation_part
8526+
id: '456'
8527+
part_type: comment
8528+
body: "<p>Hello there!</p>"
8529+
created_at: 1734537559
8530+
updated_at: 1734537561
8531+
notified_at: 1734537559
8532+
assigned_to:
8533+
author:
8534+
id: '991267694'
8535+
type: admin
8536+
name: Ciaran Lee
8537+
email: admin@email.com
8538+
attachments: []
8539+
external_id:
8540+
seen_state:
8541+
admin_seen: true
8542+
schema:
8543+
"$ref": "#/components/schemas/conversation_part"
8544+
'401':
8545+
description: Unauthorized
8546+
content:
8547+
application/json:
8548+
examples:
8549+
Unauthorized:
8550+
value:
8551+
type: error.list
8552+
request_id: a3e5b8e2-1234-5678-9abc-def012345678
8553+
errors:
8554+
- code: unauthorized
8555+
message: Access Token Invalid
8556+
schema:
8557+
"$ref": "#/components/schemas/error"
8558+
'403':
8559+
description: Forbidden
8560+
content:
8561+
application/json:
8562+
examples:
8563+
Forbidden:
8564+
value:
8565+
type: error.list
8566+
request_id: b4f6c9d3-2345-6789-abcd-ef0123456789
8567+
errors:
8568+
- code: forbidden
8569+
message: Forbidden request
8570+
schema:
8571+
"$ref": "#/components/schemas/error"
8572+
'404':
8573+
description: Conversation part not found
8574+
content:
8575+
application/json:
8576+
examples:
8577+
Conversation part not found:
8578+
value:
8579+
type: error.list
8580+
request_id: c5a7d0e4-3456-789a-bcde-f01234567890
8581+
errors:
8582+
- code: not_found
8583+
message: Resource Not Found
8584+
schema:
8585+
"$ref": "#/components/schemas/error"
8586+
requestBody:
8587+
content:
8588+
application/json:
8589+
schema:
8590+
"$ref": "#/components/schemas/update_conversation_part_request"
8591+
examples:
8592+
update_send_state:
8593+
summary: Update send state
8594+
value:
8595+
send_state: sent
8596+
info_message: Message delivered successfully
8597+
experimental: true
8598+
secret: hmac_secret_value
8599+
mark_as_seen:
8600+
summary: Mark part as seen
8601+
value:
8602+
seen: true
8603+
admin_id: '991267694'
8604+
experimental: true
8605+
secret: hmac_secret_value
84688606
"/conversations/{id}/customers":
84698607
post:
84708608
summary: Attach a contact to a conversation
@@ -23735,6 +23873,42 @@ components:
2373523873
required:
2373623874
- text
2373723875
- uuid
23876+
update_conversation_part_request:
23877+
title: Update Conversation Part Request
23878+
type: object
23879+
description: |
23880+
Payload for updating a conversation part. Supports two operations:
23881+
1. Updating the send state of an external reply (requires `send_state` and `info_message`).
23882+
2. Marking a part as seen by an admin (requires `seen` and `admin_id`).
23883+
Both operations require `experimental` and `secret` for HMAC authentication.
23884+
properties:
23885+
send_state:
23886+
type: string
23887+
description: The send state to set on the external reply.
23888+
example: sent
23889+
info_message:
23890+
type: string
23891+
description: An informational message about the send state update.
23892+
example: Message delivered successfully
23893+
seen:
23894+
type: boolean
23895+
description: Set to true to mark the conversation part as seen.
23896+
example: true
23897+
admin_id:
23898+
type: string
23899+
description: The id of the admin marking the part as seen.
23900+
example: '991267694'
23901+
experimental:
23902+
type: boolean
23903+
description: Must be true to use this experimental endpoint.
23904+
example: true
23905+
secret:
23906+
type: string
23907+
description: HMAC secret for authenticating the experimental request.
23908+
example: hmac_secret_value
23909+
required:
23910+
- experimental
23911+
- secret
2373823912
redact_conversation_request:
2373923913
oneOf:
2374023914
- title: Redact Conversation Part Request

0 commit comments

Comments
 (0)