added admonition to ticket/search api page mentioning the correct cat… #276
Conversation
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
…egories to use when searching for a ticket
mailsongabriel
approved these changes
Jul 17, 2025
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.
added admonition to ticket/search api page mentioning the correct categories to use when searching for a ticket
Why
Related Issue:
https://github.com/intercom/intercom/issues/400856
It is currently unclear in the documentation that when using the /tickets/search endpoint to search tickets, the category names customer and back-office should not be used as keywords. Instead, customer tickets are searched using the keyword 'request', and back-office tickets are searched using the keyword 'task'.
How
It was decided in the issue above that the API should be updated to make this information clearer.
This change adds an admonition to the /tickets/search documentation mentioning the correct category search keywords.