Skip to content

Commit 325310e

Browse files
jorgeintercomclaude
jorgeintercom
and
claude
committed
Add content snippets endpoints to Unstable OpenAPI spec
Add GET/POST /content_snippets and GET/PUT /content_snippets/{id} endpoints with schemas for content snippet responses and requests. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 1952aa5 commit 325310e

File tree

1 file changed

+342
-0
lines changed

1 file changed

+342
-0
lines changed

‎descriptions/0/api.intercom.io.yaml‎

Lines changed: 342 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6338,6 +6338,241 @@ paths:
63386338
application/json:
63396339
schema:
63406340
"$ref": "#/components/schemas/contact_blocked"
6341+
"/content_snippets":
6342+
get:
6343+
summary: List all content snippets
6344+
parameters:
6345+
- name: Intercom-Version
6346+
in: header
6347+
schema:
6348+
"$ref": "#/components/schemas/intercom_version"
6349+
- name: page
6350+
in: query
6351+
required: false
6352+
description: The page of results to fetch.
6353+
schema:
6354+
type: integer
6355+
example: 1
6356+
- name: per_page
6357+
in: query
6358+
required: false
6359+
description: The number of results to return per page. Max value of 50.
6360+
schema:
6361+
type: integer
6362+
example: 20
6363+
tags:
6364+
- Content Snippets
6365+
operationId: listContentSnippets
6366+
description: You can fetch a list of all content snippets for a workspace.
6367+
responses:
6368+
'200':
6369+
description: Successful response
6370+
content:
6371+
application/json:
6372+
examples:
6373+
Successful response:
6374+
value:
6375+
type: list
6376+
data:
6377+
- type: content_snippet
6378+
id: '123'
6379+
title: How to reset your password
6380+
locale: en
6381+
json_blocks:
6382+
- type: paragraph
6383+
text: Navigate to Settings > Security > Reset password.
6384+
chatbot_availability: 1
6385+
copilot_availability: 1
6386+
created_at: 1663597223
6387+
updated_at: 1663597223
6388+
total_count: 1
6389+
page: 1
6390+
per_page: 50
6391+
total_pages: 1
6392+
schema:
6393+
"$ref": "#/components/schemas/content_snippet_list"
6394+
post:
6395+
summary: Create a content snippet
6396+
parameters:
6397+
- name: Intercom-Version
6398+
in: header
6399+
schema:
6400+
"$ref": "#/components/schemas/intercom_version"
6401+
tags:
6402+
- Content Snippets
6403+
operationId: createContentSnippet
6404+
description: You can create a new content snippet.
6405+
requestBody:
6406+
required: true
6407+
content:
6408+
application/json:
6409+
schema:
6410+
"$ref": "#/components/schemas/content_snippet_create_request"
6411+
examples:
6412+
Create a content snippet:
6413+
value:
6414+
title: How to reset your password
6415+
json_blocks:
6416+
- type: paragraph
6417+
text: Navigate to Settings > Security > Reset password.
6418+
locale: en
6419+
responses:
6420+
'200':
6421+
description: Content snippet created
6422+
content:
6423+
application/json:
6424+
examples:
6425+
Content snippet created:
6426+
value:
6427+
type: content_snippet
6428+
id: '456'
6429+
title: How to reset your password
6430+
locale: en
6431+
json_blocks:
6432+
- type: paragraph
6433+
text: Navigate to Settings > Security > Reset password.
6434+
chatbot_availability: 1
6435+
copilot_availability: 1
6436+
created_at: 1663597223
6437+
updated_at: 1663597223
6438+
schema:
6439+
"$ref": "#/components/schemas/content_snippet"
6440+
'422':
6441+
description: Validation error
6442+
content:
6443+
application/json:
6444+
examples:
6445+
Validation error:
6446+
value:
6447+
type: error.list
6448+
errors:
6449+
- code: validation_error
6450+
message: The language is not currently supported for Fin
6451+
"/content_snippets/{id}":
6452+
get:
6453+
summary: Retrieve a content snippet
6454+
parameters:
6455+
- name: Intercom-Version
6456+
in: header
6457+
schema:
6458+
"$ref": "#/components/schemas/intercom_version"
6459+
- name: id
6460+
in: path
6461+
required: true
6462+
description: The unique identifier for the content snippet.
6463+
schema:
6464+
type: string
6465+
example: '123'
6466+
tags:
6467+
- Content Snippets
6468+
operationId: getContentSnippet
6469+
description: You can fetch a single content snippet by its id.
6470+
responses:
6471+
'200':
6472+
description: Successful response
6473+
content:
6474+
application/json:
6475+
examples:
6476+
Successful response:
6477+
value:
6478+
type: content_snippet
6479+
id: '123'
6480+
title: How to reset your password
6481+
locale: en
6482+
json_blocks:
6483+
- type: paragraph
6484+
text: Navigate to Settings > Security > Reset password.
6485+
chatbot_availability: 1
6486+
copilot_availability: 1
6487+
created_at: 1663597223
6488+
updated_at: 1663597223
6489+
schema:
6490+
"$ref": "#/components/schemas/content_snippet"
6491+
'404':
6492+
description: Content snippet not found
6493+
content:
6494+
application/json:
6495+
examples:
6496+
Content snippet not found:
6497+
value:
6498+
type: error.list
6499+
errors:
6500+
- code: not_found
6501+
message: Content snippet not found
6502+
put:
6503+
summary: Update a content snippet
6504+
parameters:
6505+
- name: Intercom-Version
6506+
in: header
6507+
schema:
6508+
"$ref": "#/components/schemas/intercom_version"
6509+
- name: id
6510+
in: path
6511+
required: true
6512+
description: The unique identifier for the content snippet.
6513+
schema:
6514+
type: string
6515+
example: '123'
6516+
tags:
6517+
- Content Snippets
6518+
operationId: updateContentSnippet
6519+
description: You can update an existing content snippet.
6520+
requestBody:
6521+
required: true
6522+
content:
6523+
application/json:
6524+
schema:
6525+
"$ref": "#/components/schemas/content_snippet_create_request"
6526+
examples:
6527+
Update a content snippet:
6528+
value:
6529+
title: How to reset your password (updated)
6530+
json_blocks:
6531+
- type: paragraph
6532+
text: Go to Settings > Security > Reset password and follow the steps.
6533+
responses:
6534+
'200':
6535+
description: Content snippet updated
6536+
content:
6537+
application/json:
6538+
examples:
6539+
Content snippet updated:
6540+
value:
6541+
type: content_snippet
6542+
id: '123'
6543+
title: How to reset your password (updated)
6544+
locale: en
6545+
json_blocks:
6546+
- type: paragraph
6547+
text: Go to Settings > Security > Reset password and follow the steps.
6548+
chatbot_availability: 1
6549+
copilot_availability: 1
6550+
created_at: 1663597223
6551+
updated_at: 1663597300
6552+
schema:
6553+
"$ref": "#/components/schemas/content_snippet"
6554+
'404':
6555+
description: Content snippet not found
6556+
content:
6557+
application/json:
6558+
examples:
6559+
Content snippet not found:
6560+
value:
6561+
type: error.list
6562+
errors:
6563+
- code: not_found
6564+
message: Content snippet not found
6565+
'422':
6566+
description: Validation error
6567+
content:
6568+
application/json:
6569+
examples:
6570+
Validation error:
6571+
value:
6572+
type: error.list
6573+
errors:
6574+
- code: validation_error
6575+
message: The language is not currently supported for Fin
63416576
"/conversations/{conversation_id}/tags":
63426577
post:
63436578
summary: Add tag to a conversation
@@ -20358,6 +20593,113 @@ components:
2035820593
description: The content sources used by AI Agent in the conversation.
2035920594
items:
2036020595
"$ref": "#/components/schemas/content_source"
20596+
content_snippet:
20597+
title: Content Snippet
20598+
type: object
20599+
x-tags:
20600+
- Content Snippets
20601+
description: A content snippet is a reusable piece of content for your AI agent
20602+
and Copilot.
20603+
nullable: false
20604+
properties:
20605+
type:
20606+
type: string
20607+
description: String representing the object's type. Always has the value
20608+
`content_snippet`.
20609+
example: content_snippet
20610+
id:
20611+
type: string
20612+
description: The unique identifier for the content snippet.
20613+
example: '123'
20614+
title:
20615+
type: string
20616+
description: The title of the content snippet.
20617+
nullable: true
20618+
example: How to reset your password
20619+
locale:
20620+
type: string
20621+
description: The locale of the content snippet.
20622+
example: en
20623+
json_blocks:
20624+
type: array
20625+
description: The content blocks that make up the body of the snippet.
20626+
items:
20627+
type: object
20628+
example:
20629+
- type: paragraph
20630+
text: Navigate to Settings > Security > Reset password.
20631+
chatbot_availability:
20632+
type: integer
20633+
description: Whether this snippet is available for Fin (1 = on, 0 = off).
20634+
example: 1
20635+
copilot_availability:
20636+
type: integer
20637+
description: Whether this snippet is available for Copilot (1 = on, 0 =
20638+
off).
20639+
example: 1
20640+
created_at:
20641+
type: integer
20642+
description: The time the snippet was created as a UNIX timestamp.
20643+
example: 1663597223
20644+
updated_at:
20645+
type: integer
20646+
description: The time the snippet was last updated as a UNIX timestamp.
20647+
example: 1663597223
20648+
content_snippet_list:
20649+
title: Content Snippet List
20650+
type: object
20651+
description: A paginated list of content snippets.
20652+
nullable: false
20653+
properties:
20654+
type:
20655+
type: string
20656+
enum:
20657+
- list
20658+
example: list
20659+
data:
20660+
type: array
20661+
description: An array of content snippet objects.
20662+
items:
20663+
"$ref": "#/components/schemas/content_snippet"
20664+
total_count:
20665+
type: integer
20666+
description: The total number of content snippets.
20667+
example: 1
20668+
page:
20669+
type: integer
20670+
description: The current page number.
20671+
example: 1
20672+
per_page:
20673+
type: integer
20674+
description: The number of results per page.
20675+
example: 50
20676+
total_pages:
20677+
type: integer
20678+
description: The total number of pages.
20679+
example: 1
20680+
content_snippet_create_request:
20681+
title: Content Snippet Request
20682+
type: object
20683+
description: The request payload for creating or updating a content snippet.
20684+
nullable: false
20685+
properties:
20686+
title:
20687+
type: string
20688+
description: The title of the content snippet.
20689+
maxLength: 255
20690+
example: How to reset your password
20691+
json_blocks:
20692+
type: array
20693+
description: The content blocks that make up the body of the snippet.
20694+
items:
20695+
type: object
20696+
example:
20697+
- type: paragraph
20698+
text: Navigate to Settings > Security > Reset password.
20699+
locale:
20700+
type: string
20701+
description: The locale of the content snippet. Defaults to `en`.
20702+
example: en
2036120703
conversation_list_item:
2036220704
title: Conversation List Item
2036320705
type: object

0 commit comments

Comments
 (0)