Skip to content

Document reading a ticket's priority back from the API (Preview) - #648

Closed
hrp wants to merge 1 commit into
mainfrom
hitenparmar/ticket-priority-read-docs
Closed

hrp wants to merge 1 commit into
mainfrom
hitenparmar/ticket-priority-read-docs

Conversation

@hrp

@hrp hrp commented Aug 28, 2026 •

Copy link
Copy Markdown
Contributor

Why?

Setting a ticket's priority is already documented, but nothing describes reading it back, so an integration that writes a level has no documented way to confirm it stuck short of fetching the underlying conversation. The ticket schema omits the field entirely, which stops being accurate once the read side ships.

How?

Adds the priority level to the Preview ticket response schema, copying the shape the conversation object already uses.

Notes for reviewers
  • Affected versions: Preview only. No dated version changes.
  • Draft on purpose. This should only merge once the API change has shipped, or the spec will describe a field that isn't being returned yet.
  • The spec addition is byte-identical to the developer-docs copy, diffed to confirm the two stay in step.
  • The five levels and the description are lifted from the conversation object's existing priority field.

Spec mirror, merge alongside this one:

Follows on from:

Generated with Claude Code

Mirrors the developer-docs spec addition so the two stay in step. The
ticket object returns priority with the same levels the update endpoint
already accepts.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@hrp

hrp commented Nov 3, 2026

Copy link
Copy Markdown
Contributor Author

Closing: the read-side change this documents (intercom/intercom#566184) was closed unmerged, so the API doesn't return this field. Reopen if that ships.

@hrp hrp closed this Nov 3, 2026
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.

1 participant