Skip to content

Commit 6ee26cf

Browse files
efassorclaude
andauthored
Move company notes API to Unstable: fix path params and add company property to note schema (#380)
- Fix path parameter: {id} → {company_id} to match Rails route - Add company property to note schema (mirrors contact property) - Update note schema description to mention companies Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 99025e8 commit 6ee26cf

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3683,11 +3683,11 @@ paths:
36833683
message: Access Token Invalid
36843684
schema:
36853685
"$ref": "#/components/schemas/error"
3686-
"/companies/{id}/notes":
3686+
"/companies/{company_id}/notes":
36873687
get:
36883688
summary: List all company notes
36893689
parameters:
3690-
- name: id
3690+
- name: company_id
36913691
in: path
36923692
required: true
36933693
description: The unique identifier for the company which is given by Intercom
@@ -3793,7 +3793,7 @@ paths:
37933793
in: header
37943794
schema:
37953795
"$ref": "#/components/schemas/intercom_version"
3796-
- name: id
3796+
- name: company_id
37973797
in: path
37983798
required: true
37993799
description: The unique identifier for the company which is given by Intercom
@@ -25284,7 +25284,8 @@ components:
2528425284
type: object
2528525285
x-tags:
2528625286
- Notes
25287-
description: Notes allow you to annotate and comment on your contacts.
25287+
description: Notes allow you to annotate and comment on your contacts and companies.
25288+
A note is attached to either a contact or a company, never both.
2528825289
properties:
2528925290
type:
2529025291
type: string
@@ -25313,6 +25314,19 @@ components:
2531325314
type: string
2531425315
description: The id of the contact.
2531525316
example: 214656d0c743eafcfde7f248
25317+
company:
25318+
type: object
25319+
description: Represents the company that the note was created about.
25320+
nullable: true
25321+
properties:
25322+
type:
25323+
type: string
25324+
description: String representing the object's type. Always has the value
25325+
`company`.
25326+
id:
25327+
type: string
25328+
description: The id of the company.
25329+
example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
2531625330
author:
2531725331
"$ref": "#/components/schemas/admin"
2531825332
description: Optional. Represents the Admin that created the note.

0 commit comments

Comments
 (0)