Skip to content

Commit abbfca5

Browse files
cathalgingclaude
andcommitted
Address review feedback on Knowledge endpoint docs
Narrow the tag applied_at/applied_by null case to content removals, say that the detach admin_id is checked but not recorded, document the missing internal article errors, add the content search 401 scope example, note values returned as strings, and add request_id and per_page to a few examples. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
1 parent 1835a77 commit abbfca5

2 files changed

Lines changed: 208 additions & 30 deletions

File tree

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

Lines changed: 104 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5736,7 +5736,7 @@ paths:
57365736
Requires the `read_articles_scope` or `read_write_articles_scope` OAuth scope.
57375737
responses:
57385738
'200':
5739-
description: successful
5739+
description: successful. `pages.page` and `pages.per_page` are returned as strings when you send `page` and `per_page` in the request, and as integers otherwise.
57405740
content:
57415741
application/json:
57425742
examples:
@@ -5817,7 +5817,26 @@ paths:
58175817
schema:
58185818
"$ref": "#/components/schemas/internal_article"
58195819
'400':
5820-
description: Bad request. The request body is empty.
5820+
description: Bad request. The request body is empty, in which case the response has no body, or `audience_ids` is not an array of integers
5821+
content:
5822+
application/json:
5823+
examples:
5824+
audience_ids is not an array:
5825+
value:
5826+
type: error.list
5827+
request_id: null
5828+
errors:
5829+
- code: data_invalid
5830+
message: audience_ids must be an array
5831+
audience_ids contains a non-integer:
5832+
value:
5833+
type: error.list
5834+
request_id: null
5835+
errors:
5836+
- code: data_invalid
5837+
message: audience_ids must contain only integer values
5838+
schema:
5839+
"$ref": "#/components/schemas/error"
58215840
'404':
58225841
description: Teammate, folder or audience ID not found
58235842
content:
@@ -5847,7 +5866,7 @@ paths:
58475866
schema:
58485867
"$ref": "#/components/schemas/error"
58495868
'422':
5850-
description: Missing required parameters, or body_markdown sent with body or json_blocks
5869+
description: Missing required parameters, body_markdown sent with body or json_blocks, or an ai_*_availability value that is not a boolean
58515870
content:
58525871
application/json:
58535872
examples:
@@ -5865,6 +5884,13 @@ paths:
58655884
errors:
58665885
- code: parameter_invalid
58675886
message: body_markdown is mutually exclusive with body and json_blocks - please provide only one
5887+
Non-boolean availability flag:
5888+
value:
5889+
type: error.list
5890+
request_id: null
5891+
errors:
5892+
- code: parameter_invalid
5893+
message: ai_chatbot_availability must be a boolean (true or false)
58685894
schema:
58695895
"$ref": "#/components/schemas/error"
58705896
'401':
@@ -6042,9 +6068,28 @@ paths:
60426068
schema:
60436069
"$ref": "#/components/schemas/internal_article"
60446070
'400':
6045-
description: Bad request. The request body is empty.
6071+
description: Bad request. The request body is empty, in which case the response has no body, or `audience_ids` is not an array of integers
6072+
content:
6073+
application/json:
6074+
examples:
6075+
audience_ids is not an array:
6076+
value:
6077+
type: error.list
6078+
request_id: null
6079+
errors:
6080+
- code: data_invalid
6081+
message: audience_ids must be an array
6082+
audience_ids contains a non-integer:
6083+
value:
6084+
type: error.list
6085+
request_id: null
6086+
errors:
6087+
- code: data_invalid
6088+
message: audience_ids must contain only integer values
6089+
schema:
6090+
"$ref": "#/components/schemas/error"
60466091
'404':
6047-
description: Internal article, folder or audience ID not found
6092+
description: Internal article, teammate, folder or audience ID not found
60486093
content:
60496094
application/json:
60506095
examples:
@@ -6055,6 +6100,13 @@ paths:
60556100
errors:
60566101
- code: not_found
60576102
message: Resource not found
6103+
Teammate not found:
6104+
value:
6105+
type: error.list
6106+
request_id: null
6107+
errors:
6108+
- code: parameter_invalid
6109+
message: Admin with ID 999999 not found
60586110
Folder not found:
60596111
value:
60606112
type: error.list
@@ -6072,7 +6124,7 @@ paths:
60726124
schema:
60736125
"$ref": "#/components/schemas/error"
60746126
'422':
6075-
description: body_markdown sent with body or json_blocks, or the article is in a release running a live experiment
6127+
description: body_markdown sent with body or json_blocks, an ai_*_availability value that is not a boolean, or the article is in a release running a live experiment
60766128
content:
60776129
application/json:
60786130
examples:
@@ -6083,6 +6135,13 @@ paths:
60836135
errors:
60846136
- code: parameter_invalid
60856137
message: body_markdown is mutually exclusive with body and json_blocks - please provide only one
6138+
Non-boolean availability flag:
6139+
value:
6140+
type: error.list
6141+
request_id: null
6142+
errors:
6143+
- code: parameter_invalid
6144+
message: ai_chatbot_availability must be a boolean (true or false)
60866145
Release live experiment conflict:
60876146
value:
60886147
type: error.list
@@ -6350,8 +6409,9 @@ paths:
63506409
- name: admin_id
63516410
in: query
63526411
required: false
6353-
description: Optional id of the teammate to attribute the removal to. Defaults
6354-
to the authenticating teammate.
6412+
description: Optional id of a teammate. The id is checked, and an unknown
6413+
teammate returns a 404 `admin_not_found` error, but the removal is not
6414+
recorded against the teammate.
63556415
example: '1234'
63566416
schema:
63576417
type: string
@@ -6567,7 +6627,7 @@ paths:
65676627
Requires the `read_articles_scope` or `read_write_articles_scope` OAuth scope.
65686628
responses:
65696629
'200':
6570-
description: successful
6630+
description: successful. `pages.page` and `pages.per_page` are returned as strings when you send `page` and `per_page` in the request, and as integers otherwise.
65716631
content:
65726632
application/json:
65736633
example:
@@ -14428,7 +14488,26 @@ paths:
1442814488
schema:
1442914489
"$ref": "#/components/schemas/error"
1443014490
'401':
14431-
$ref: "#/components/responses/Unauthorized"
14491+
description: Unauthorized. The token is invalid or is missing the `read_content` OAuth scope
14492+
content:
14493+
application/json:
14494+
examples:
14495+
Unauthorized:
14496+
value:
14497+
type: error.list
14498+
request_id: 12a938a3-314e-4939-b773-5cd45738bd21
14499+
errors:
14500+
- code: unauthorized
14501+
message: Access Token Invalid
14502+
Token lacks required scope:
14503+
value:
14504+
type: error.list
14505+
request_id: a3e5b8e2-1234-5678-9abc-def012345678
14506+
errors:
14507+
- code: token_unauthorized
14508+
message: Not authorized to access resource
14509+
schema:
14510+
"$ref": "#/components/schemas/error"
1443214511
'422':
1443314512
description: Invalid filter value
1443414513
content:
@@ -14601,12 +14680,14 @@ paths:
1460114680
Invalid availability flag:
1460214681
value:
1460314682
type: error.list
14683+
request_id: 7c1d9e2a-3b4f-4a56-8d70-1e2f3a4b5c6d
1460414684
errors:
1460514685
- code: parameter_invalid
1460614686
message: ai_chatbot_availability must be a boolean
1460714687
Malformed audience_ids:
1460814688
value:
1460914689
type: error.list
14690+
request_id: 9a8b7c6d-5e4f-4321-b0a9-8f7e6d5c4b3a
1461014691
errors:
1461114692
- code: data_invalid
1461214693
message: audience_ids must be an array
@@ -14641,6 +14722,7 @@ paths:
1464114722
Unknown audience IDs:
1464214723
value:
1464314724
type: error.list
14725+
request_id: 2b3c4d5e-6f70-4812-93a4-b5c6d7e8f901
1464414726
errors:
1464514727
- code: parameter_invalid
1464614728
message: 'audience_ids contains unknown audience IDs: 999'
@@ -14661,6 +14743,7 @@ paths:
1466114743
Body and JSON blocks both provided:
1466214744
value:
1466314745
type: error.list
14746+
request_id: 4d5e6f70-8192-4a3b-8c4d-5e6f708192a3
1466414747
errors:
1466514748
- code: parameter_invalid
1466614749
message: body_markdown and json_blocks are mutually exclusive - please provide only one
@@ -14824,12 +14907,14 @@ paths:
1482414907
Invalid availability flag:
1482514908
value:
1482614909
type: error.list
14910+
request_id: 6f708192-a3b4-4c5d-9e6f-708192a3b4c5
1482714911
errors:
1482814912
- code: parameter_invalid
1482914913
message: ai_chatbot_availability must be a boolean
1483014914
Malformed audience_ids:
1483114915
value:
1483214916
type: error.list
14917+
request_id: 8192a3b4-c5d6-4e7f-8091-a2b3c4d5e6f7
1483314918
errors:
1483414919
- code: data_invalid
1483514920
message: audience_ids must be an array
@@ -14871,6 +14956,7 @@ paths:
1487114956
Unknown audience IDs:
1487214957
value:
1487314958
type: error.list
14959+
request_id: a3b4c5d6-e7f8-4091-a2b3-c4d5e6f70819
1487414960
errors:
1487514961
- code: parameter_invalid
1487614962
message: 'audience_ids contains unknown audience IDs: 999'
@@ -14891,6 +14977,7 @@ paths:
1489114977
Body and JSON blocks both provided:
1489214978
value:
1489314979
type: error.list
14980+
request_id: c5d6e7f8-0912-4a3b-b4c5-d6e7f8091a2b
1489414981
errors:
1489514982
- code: parameter_invalid
1489614983
message: body_markdown and json_blocks are mutually exclusive - please provide only one
@@ -15124,8 +15211,9 @@ paths:
1512415211
- name: admin_id
1512515212
in: query
1512615213
required: false
15127-
description: Optional id of the teammate to attribute the removal to. Defaults
15128-
to the authenticating teammate.
15214+
description: Optional id of a teammate. The id is checked, and an unknown
15215+
teammate returns a 404 `admin_not_found` error, but the removal is not
15216+
recorded against the teammate.
1512915217
example: '1234'
1513015218
schema:
1513115219
type: string
@@ -38761,13 +38849,13 @@ components:
3876138849
format: uri
3876238850
description: A link to the next page of results. Omitted when on the
3876338851
last page.
38764-
example: https://api.intercom.io/content/search?query=billing&page=2
38852+
example: https://api.intercom.io/content/search?query=billing&per_page=10&page=2
3876538853
prev:
3876638854
type: string
3876738855
format: uri
3876838856
description: A link to the previous page of results. Omitted when on
3876938857
the first page.
38770-
example: https://api.intercom.io/content/search?query=billing&page=1
38858+
example: https://api.intercom.io/content/search?query=billing&per_page=10&page=1
3877138859
data:
3877238860
type: array
3877338861
description: The list of matched content items. Each item's `type`
@@ -38819,7 +38907,8 @@ components:
3881938907
example: en
3882038908
json_blocks:
3882138909
type: array
38822-
description: The content blocks that make up the body of the snippet.
38910+
description: The content blocks that make up the body of the snippet. In
38911+
responses, the blocks are returned as a JSON-encoded string rather than as an array.
3882338912
items:
3882438913
type: object
3882538914
example:

0 commit comments

Comments
 (0)