Skip to content

Commit 986af6c

Browse files
authored
Merge branch 'main' into faiz/allow-ticket-updates-custom-admin-docs
2 parents f80a408 + f120734 commit 986af6c

File tree

1 file changed

+76
-12
lines changed

1 file changed

+76
-12
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 76 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1443,6 +1443,29 @@ paths:
14431443
message: Access Token Invalid
14441444
schema:
14451445
"$ref": "#/components/schemas/error"
1446+
"/away_status_reasons":
1447+
get:
1448+
summary: List all away status reasons
1449+
parameters:
1450+
- name: Intercom-Version
1451+
in: header
1452+
schema:
1453+
"$ref": "#/components/schemas/intercom_version"
1454+
tags:
1455+
- Away Status Reasons
1456+
operationId: listAwayStatusReasons
1457+
description: "Returns a list of all away status reasons configured for the workspace, including deleted ones."
1458+
responses:
1459+
'200':
1460+
description: Successful response
1461+
content:
1462+
application/json:
1463+
schema:
1464+
type: array
1465+
items:
1466+
$ref: "#/components/schemas/away_status_reason"
1467+
'401':
1468+
"$ref": "#/components/responses/Unauthorized"
14461469
"/help_center/collections":
14471470
get:
14481471
summary: List all collections
@@ -13549,7 +13572,7 @@ components:
1354913572
customer:
1355013573
"$ref": "#/components/schemas/customer_request"
1355113574
required:
13552-
- intercom_user_id
13575+
- intercom_user_id
1355313576
- title: User ID
1355413577
properties:
1355513578
user_id:
@@ -13560,7 +13583,7 @@ components:
1356013583
customer:
1356113584
"$ref": "#/components/schemas/customer_request"
1356213585
required:
13563-
- user_id
13586+
- user_id
1356413587
- title: Email
1356513588
properties:
1356613589
email:
@@ -13571,7 +13594,40 @@ components:
1357113594
customer:
1357213595
"$ref": "#/components/schemas/customer_request"
1357313596
required:
13574-
- email
13597+
- email
13598+
away_status_reason:
13599+
type: object
13600+
properties:
13601+
type:
13602+
type: string
13603+
example: "away_status_reason"
13604+
id:
13605+
type: string
13606+
description: "The unique identifier for the away status reason"
13607+
label:
13608+
type: string
13609+
description: "The display text for the away status reason"
13610+
example: "On a break"
13611+
emoji:
13612+
type: string
13613+
description: "The emoji associated with the status reason"
13614+
example: "☕"
13615+
order:
13616+
type: integer
13617+
description: "The display order of the status reason"
13618+
example: 1
13619+
deleted:
13620+
type: boolean
13621+
description: "Whether the status reason has been soft deleted"
13622+
example: false
13623+
created_at:
13624+
type: integer
13625+
description: "The Unix timestamp when the status reason was created"
13626+
example: 1734537243
13627+
updated_at:
13628+
type: integer
13629+
description: "The Unix timestamp when the status reason was last updated"
13630+
example: 1734537243
1357513631
close_conversation_request:
1357613632
title: Close Conversation Request
1357713633
type: object
@@ -19607,24 +19663,26 @@ security:
1960719663
- bearerAuth: []
1960819664
tags:
1960919665
- name: Admins
19610-
description: Everything about your Admins
19666+
description: Everything about your Admins
1961119667
- name: AI Content
1961219668
description: |
1961319669
With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
19614-
19670+
1961519671
 
19616-
19672+
1961719673
*External Pages* are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
19618-
19674+
1961919675
 
19620-
19676+
1962119677
*Content Import Sources* are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
19622-
19678+
1962319679
 
19624-
19680+
1962519681
You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an *external_id* parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
1962619682
- name: Articles
1962719683
description: Everything about your Articles
19684+
- name: Away Status Reasons
19685+
description: Everything about your Away Status Reasons
1962819686
- name: Companies
1962919687
description: Everything about your Companies
1963019688
- name: Contacts
@@ -19635,7 +19693,11 @@ tags:
1963519693
description: What is a conversation?
1963619694
url: https://www.intercom.com/help/en/articles/4323904-what-is-a-conversation
1963719695
- name: Custom Object Instances
19638-
description: Everything about your Custom Object instances.
19696+
description: |
19697+
Everything about your Custom Object instances.
19698+
{% admonition type="warning" name="Permission Requirements" %}
19699+
From now on, to access this endpoint, you need additional permissions. Please head over to the [Developer Hub](https://app.intercom.com/a/apps/_/developer-hub) app package authentication settings to configure the required permissions.
19700+
{% /admonition %}
1963919701
- name: Data Attributes
1964019702
description: Everything about your Data Attributes
1964119703
- name: Data Events
@@ -19644,6 +19706,8 @@ tags:
1964419706
description: Everything about your Data Exports
1964519707
- name: Help Center
1964619708
description: Everything about your Help Center
19709+
- name: Jobs
19710+
description: Everything about jobs
1964719711
- name: Messages
1964819712
description: Everything about your messages
1964919713
- name: News
@@ -19675,4 +19739,4 @@ tags:
1967519739
- name: Tickets
1967619740
description: Everything about your tickets
1967719741
- name: Visitors
19678-
description: Everything about your Visitors
19742+
description: Everything about your Visitors

0 commit comments

Comments
 (0)