Skip to content

Document PUT /conversations/{conversation_id}/conversation_parts/{id}#406

Merged
salmanbshah merged 1 commit intomainfrom
salmanshah/docs-conversation-parts-update-api
Mar 16, 2026
Merged

Document PUT /conversations/{conversation_id}/conversation_parts/{id}#406
salmanbshah merged 1 commit intomainfrom
salmanshah/docs-conversation-parts-update-api

Conversation

@salmanbshah
Copy link
Contributor

@salmanbshah salmanbshah commented Mar 16, 2026

Why?

PUT /conversations/{conversation_id}/conversation_parts/{id} was implemented in ConversationPartsController but completely absent from all specs. Customers building integrations that need to update conversation part state (e.g. marking parts as seen, updating send state for external replies) had no documented API surface to work with.

How?

Added PUT /conversations/{conversation_id}/conversation_parts/{id} to the Unstable spec under the Conversations tag. The endpoint supports two operations via the same path: updating the send state of an external reply (send_state + info_message) and marking a part as seen by an admin (seen + admin_id). Includes a new update_conversation_part_request schema with 200/401/403/404 responses.

Decisions

  • Unstable only: This endpoint uses experimental HMAC auth fields not yet stabilised across API versions.
  • Single endpoint, two operations: The controller uses a single update action for both send state and seen state updates — documented as one endpoint with a flexible request body rather than two separate paths, matching the backend design.
Implementation Plan

API Documentation Gap Plan

Confirmed Gaps (this PR covers gap #3)

# Controller Missing Endpoints Spec Target
1 api/v3/data_connectors_controller.rb GET /data_connectors/{id} Unstable only
2 api/v3/fin_voice_controller.rb GET /fin_voice/conversation/{conversation_id} Unstable + v2.15
3 api/v3/conversation_parts_controller.rb PUT /conversations/{conversation_id}/conversation_parts/{id} Unstable only
4 api/v3/messages_controller.rb GET /messages/whatsapp/status Unstable only

Skipped (feature-flagged, not yet GA)

  • fin/tasks_controller.rbai_answers_billing_feature
  • fin/api_controller.rbfin-agent-api
  • procedures_controller.rbProcedureRuns::Constants::FEATURE_FLAG

Generated with Claude Code

…dpoint

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
@salmanbshah salmanbshah enabled auto-merge (squash) March 16, 2026 13:27
@salmanbshah salmanbshah merged commit 8e29306 into main Mar 16, 2026
3 checks passed
@salmanbshah salmanbshah deleted the salmanshah/docs-conversation-parts-update-api branch March 16, 2026 13:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants