Add POST /companies/{id}/notes endpoint to OpenAPI spec (Unstable)#374
Open
Add POST /companies/{id}/notes endpoint to OpenAPI spec (Unstable)#374
Conversation
### Why?
The implementation in PR #470943 adds the ability to create notes on company records
via the API, but requires corresponding OpenAPI documentation.
### How?
Add the POST endpoint to the Unstable version of the OpenAPI spec, following the same
pattern as the existing POST /contacts/{id}/notes endpoint.
<sub>Generated with Claude Code</sub>
Fixes: - Remove company_id from request body (conflicts with path parameter) - Add 401 Unauthorized response - Clarify 404 description (company OR admin not found) - Improve admin_id description (explain default behavior) - Remove company_id from request examples Co-Authored-By: Claude Sonnet 4.5 <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
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?
PR #470943 added the ability to create notes on company records via the API, but the OpenAPI specification wasn't updated. Developers need the OpenAPI documentation to discover and use this new endpoint, and downstream tools/SDKs rely on the spec for code generation.
How?
Added the POST endpoint to the Unstable version (
descriptions/0/api.intercom.io.yaml) following the same pattern as the existing POST/contacts/{id}/notesendpoint, with company-specific adaptations (UUID string IDs instead of integer IDs).Implementation Details
Endpoint:
POST /companies/{id}/notesOperation ID:
createCompanyNoteTags: Notes, Companies
Key differences from contact notes:
type: string(UUIDs) vs contact IDs which aretype: integercompany_idinstead ofcontact_idcompanyobject instead ofcontactobjectRequest Body:
body(string, required): The note textcompany_id(string): Company UUIDadmin_id(string): Admin ID (defaults to token owner if not provided)Responses:
OAuth Scope:
post_companies_listGenerated with Claude Code