Skip to content

Commit 9c37a5e

Browse files
efassorclaude
andcommitted
Move company notes API from 2.15 to Unstable (descriptions/0/)
- Revert 2.15 changes (feature moves to Unstable per versioning policy) - Fix path parameter name: id → company_id to match Rails route - Add company property to note schema - Update note schema description to mention companies Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 4a47ea8 commit 9c37a5e

File tree

2 files changed

+206
-115
lines changed

2 files changed

+206
-115
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3220,11 +3220,11 @@ paths:
32203220
message: Access Token Invalid
32213221
schema:
32223222
"$ref": "#/components/schemas/error"
3223-
"/companies/{id}/notes":
3223+
"/companies/{company_id}/notes":
32243224
get:
32253225
summary: List all company notes
32263226
parameters:
3227-
- name: id
3227+
- name: company_id
32283228
in: path
32293229
required: true
32303230
description: The unique identifier for the company which is given by Intercom
@@ -3330,7 +3330,7 @@ paths:
33303330
in: header
33313331
schema:
33323332
"$ref": "#/components/schemas/intercom_version"
3333-
- name: id
3333+
- name: company_id
33343334
in: path
33353335
required: true
33363336
description: The unique identifier for the company which is given by Intercom
@@ -21963,7 +21963,8 @@ components:
2196321963
type: object
2196421964
x-tags:
2196521965
- Notes
21966-
description: Notes allow you to annotate and comment on your contacts.
21966+
description: Notes allow you to annotate and comment on your contacts and companies.
21967+
A note is attached to either a contact or a company, never both.
2196721968
properties:
2196821969
type:
2196921970
type: string
@@ -21992,6 +21993,19 @@ components:
2199221993
type: string
2199321994
description: The id of the contact.
2199421995
example: 214656d0c743eafcfde7f248
21996+
company:
21997+
type: object
21998+
description: Represents the company that the note was created about.
21999+
nullable: true
22000+
properties:
22001+
type:
22002+
type: string
22003+
description: String representing the object's type. Always has the value
22004+
`company`.
22005+
id:
22006+
type: string
22007+
description: The id of the company.
22008+
example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
2199522009
author:
2199622010
"$ref": "#/components/schemas/admin"
2199722011
description: Optional. Represents the Admin that created the note.

0 commit comments

Comments
 (0)