Document that ticket comments are not supported on internal ticket types - #671
Merged
Merged
Conversation
POST /tickets/{id}/reply does not support message_type: comment on tracker
tickets, or on back-office tickets that are not shared with the customer. Both
are internal ticket types with no customer to send a comment to, but the
reference did not say so.
The same wording is added to every version that documents an admin reply:
Preview (descriptions/0) and 2.10 through 2.16. Earlier versions define no
admin reply schema.
The reply endpoint's 400 response was described as "User reply" and carried a single example, so it covered only a user reply on a back-office ticket. It now also describes the rejections for an admin comment on a back-office ticket that is not shared with the customer, and on a tracker ticket. Version 2.10 declared no 400 on this operation at all, so the response is added there.
Contributor
|
Are the examples for bad request not need in here as well? |
Contributor
Author
|
Yes — good catch, they were missing. Just pushed them, so the spec here now matches. Both rejection examples are added to the |
adisan19
approved these changes
Sep 21, 2026
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
3 participants
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 reply endpoint does not accept a comment on a tracker ticket, or on a back-office ticket that is not shared with the customer. Both are internal ticket types with no customer to send a comment to, and the reference documented neither the restriction nor the error these requests return.
How?
Adds the restriction to the admin reply schema on every version that documents an admin reply, and documents the
400response for those rejections — including on 2.10, which declared no400on this operation at all.Generated with Claude Code