Skip to content

Commit bfb5845

Browse files
committed
Add company_note and company_note_list schemas for company-specific notes
1 parent fcf2b7b commit bfb5845

File tree

1 file changed

+44
-32
lines changed

1 file changed

+44
-32
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 44 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -16526,40 +16526,10 @@ components:
1652616526
description: The type of the object
1652716527
enum:
1652816528
- note.list
16529-
example: note.list
16530-
data:
16529+
notes:
1653116530
type: array
16532-
description: An array containing note objects
1653316531
items:
16534-
type: object
16535-
properties:
16536-
id:
16537-
type: string
16538-
description: The id of the note
16539-
type:
16540-
type: string
16541-
description: The type of the object
16542-
enum:
16543-
- note
16544-
url:
16545-
type: string
16546-
description: The URL of the note
16547-
body:
16548-
type: string
16549-
description: The body of the note in HTML format
16550-
example: []
16551-
url:
16552-
type: string
16553-
description: The URL to get all notes associated with the company
16554-
example: "/companies/6762f0761bb69f9f2193bae2/notes"
16555-
total_count:
16556-
type: integer
16557-
description: The total number of notes associated with the company
16558-
example: 0
16559-
has_more:
16560-
type: boolean
16561-
description: Whether there are more notes than returned
16562-
example: false
16532+
"$ref": "#/components/schemas/company_note"
1656316533
company_attached_contacts:
1656416534
title: Company Attached Contacts
1656516535
type: object
@@ -21187,6 +21157,48 @@ components:
2118721157
example: 1
2118821158
pages:
2118921159
"$ref": "#/components/schemas/cursor_pages"
21160+
company_note:
21161+
title: Company Note
21162+
type: object
21163+
x-tags:
21164+
- Notes
21165+
description: Notes allow you to annotate and comment on companies.
21166+
properties:
21167+
type:
21168+
type: string
21169+
description: String representing the object's type. Always has the value
21170+
`note`.
21171+
example: note
21172+
id:
21173+
type: string
21174+
description: The id of the note.
21175+
example: '17495962'
21176+
created_at:
21177+
type: integer
21178+
format: timestamp
21179+
description: The time the note was created.
21180+
example: 1674589321
21181+
company:
21182+
type: object
21183+
description: Represents the company that the note was created about.
21184+
nullable: true
21185+
properties:
21186+
type:
21187+
type: string
21188+
description: String representing the object's type. Always has the value
21189+
`company`.
21190+
example: company
21191+
id:
21192+
type: string
21193+
description: The id of the company.
21194+
example: 6329bd9ffe4e2e91dac76188
21195+
author:
21196+
"$ref": "#/components/schemas/admin"
21197+
description: Optional. Represents the Admin that created the note.
21198+
body:
21199+
type: string
21200+
description: The body text of the note.
21201+
example: "<p>Text for the note.</p>"
2119021202
open_conversation_request:
2119121203
title: Open Conversation Request
2119221204
type: object

0 commit comments

Comments
 (0)