docs: Add Folder Management API to Unstable spec#387
Merged
sametozcan merged 7 commits intomainfrom Mar 12, 2026
Merged
Conversation
- Add folder_id field to internal_article schema (nullable)
- Add folder_id parameter to create internal article request
- Add folder_id query parameter to search endpoint (already present)
- Add new endpoints:
* GET /internal_articles/folders - List all folders
* POST /internal_articles/folders - Create a folder
* GET /internal_articles/folders/{id} - Get folder details
* PUT /internal_articles/folders/{id} - Update a folder
* DELETE /internal_articles/folders/{id} - Delete empty folder
* POST /internal_articles/move_to_folder - Bulk move articles
- Add schemas:
* internal_article_folder
* internal_article_folder_list
* create_internal_article_folder_request
* update_internal_article_folder_request
This enables folder management for internal articles through the API,
allowing customers to organize their internal documentation.
Relates to: intercom/intercom#472943
Update OpenAPI specification to reflect folder endpoints moving from /internal_articles/folders to top-level /folders resource. Changes: - Update paths: /internal_articles/folders → /folders - Update operation IDs: Remove "InternalArticle" prefix - Change tags: "Internal Articles" → "Folders" - Update descriptions: Remove "for internal articles" references - Remove bulk move endpoint /internal_articles/move_to_folder This makes folders a first-class organizational structure that can be used across multiple content types, not just internal articles. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add parent_folder_id query param to GET /folders for hierarchy filtering - Rename article_count to content_count to match monolith presenter - Add folder_id to article_list_item, create/update article requests - Add folder_id to update_internal_article_request - Add phrase query param and fix folder_id type on internal articles search - Add deleted_folder_object schema for delete response - Fix owner_id description in update_internal_article_request Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
sametozcan
force-pushed
the
samet/add-internal-articles-folders-api
branch
from
aa3f37c to
ab102b2
Compare
Folders are a top-level resource that can hold both articles and internal articles. Rename internal_article_folder* schemas to folder* to reflect this. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Remove phrase query param from internal articles search (not implemented) - Inline folder_list, create_folder_request, update_folder_request schemas directly into endpoint definitions instead of separate schema refs - Remove standalone schema definitions for the above - Keep folder and deleted_folder_object as reusable schemas Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
sametozcan
changed the title
auroralimin
reviewed
Mar 12, 2026
Contributor
auroralimin
left a comment
auroralimin
left a comment
There was a problem hiding this comment.
Basically all the same comments I left at https://github.com/intercom/developer-docs/pull/764#pullrequestreview-3935086530
Eclairemoy
reviewed
Mar 12, 2026
| example: 123 | ||
| schema: | ||
| type: string | ||
| type: integer |
Contributor
There was a problem hiding this comment.
just adding a note to make sure that this is really an int!
Contributor
Author
There was a problem hiding this comment.
Yes, this is an integer
Eclairemoy
reviewed
Mar 12, 2026
| description: A folder for organizing content | ||
| properties: | ||
| id: | ||
| type: integer |
Contributor
There was a problem hiding this comment.
same thing here. only pointing this out bc we have a lot of IDs that are strings. they should really be ints but they're not.
Contributor
Author
There was a problem hiding this comment.
Folder ID is integer in the model
Eclairemoy
approved these changes
Mar 12, 2026
Add 401 Unauthorized to Create, Retrieve, Update, Delete folder endpoints. Add 422 Validation error to Update folder endpoint. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Create and Update folder endpoints now return 400 Bad Request for validation errors. 422 is reserved for Delete when folder has content. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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?
Folder endpoints are being refactored from
/internal_articles/foldersto top-level/foldersto make folders a first-class organizational structure that can be used across multiple content types (internal articles, help center articles, etc.) in the future, not just internal articles.How?
Updated the OpenAPI specification to reflect the new folder endpoint structure and removed the bulk move endpoint that's not needed initially.
Issue: https://github.com/intercom/intercom/issues/477358
Generated with Claude Code