Add OpenAPI spec for ticket linked conversations endpoints#483
Open
MatthewPelyhes wants to merge 1 commit intomainfrom
Open
Add OpenAPI spec for ticket linked conversations endpoints#483MatthewPelyhes wants to merge 1 commit intomainfrom
MatthewPelyhes wants to merge 1 commit intomainfrom
Conversation
Add two new endpoints to the Preview/Unstable spec:
- POST /tickets/{ticket_id}/linked_conversations
Links a conversation to a tracker ticket. Returns the linked
conversation object. Includes error handling for invalid ticket
types, already-linked conversations, and limit exceeded.
- DELETE /tickets/{ticket_id}/linked_conversations/{id}
Unlinks a conversation from a tracker ticket. Returns the
unlinked conversation object.
Both endpoints follow existing nested ticket sub-resource patterns
(tags, change_type) with full error response examples, Intercom-Version
header, and Conversation schema references.
Companion to intercom/intercom#496216.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
The API supports linking and unlinking conversations to tracker tickets, but the OpenAPI spec has no definitions for these endpoints. Without spec coverage, they won't appear in generated SDK clients (TypeScript, Java, Python, PHP), API explorers, or documentation.
How?
Added two new endpoint definitions to the Preview spec (
descriptions/0/api.intercom.io.yaml), following the existing nested ticket sub-resource patterns (tags, change_type):POST /tickets/{ticket_id}/linked_conversations— link a conversation to a tracker ticketDELETE /tickets/{ticket_id}/linked_conversations/{id}— unlink a conversation from a tracker ticketBoth include full request/response schemas, inline examples, and error response documentation (400, 401, 404).
Implementation Plan
Endpoints Added
POST /tickets/{ticket_id}/linked_conversations
linkConversationToTicket[Tickets]Intercom-Versionheader +ticket_idpath param{ conversation_id: string }(required)$ref: "#/components/schemas/conversation"parameter_not_found,invalid_ticket_type,already_linked_to_tracker,linked_conversation_limit_exceeded,intercom_version_invalidticket_not_found,conversation_not_foundunauthorizedDELETE /tickets/{ticket_id}/linked_conversations/{id}
unlinkConversationFromTicket[Tickets]Intercom-Versionheader +ticket_id+idpath paramsinvalid_ticket_type,intercom_version_invalidticket_not_found,conversation_not_foundunauthorizedDesign Decisions
[Tickets]only — these are ticket sub-resource operations, matching existing patterns likechangeTicketType.bearerAuth— no per-endpoint scope overrides (follows spec convention)./tickets/{ticket_id}/tags/{id}and/tickets— sub-resources are grouped before collection endpoints.Generated with Claude Code