Skip to content

Commit 5e6f635

Browse files
Improve help center response and brand description (#301)
* Add url_prefix and custom_domain fields to help center API response examples 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]> * Add default brand id explaination --------- Co-authored-by: Claude <[email protected]>
1 parent 90fd0f7 commit 5e6f635

File tree

9 files changed

+31
-11
lines changed

9 files changed

+31
-11
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2163,6 +2163,8 @@ paths:
21632163
identifier: help-center-1
21642164
website_turned_on: false
21652165
display_name: Intercom Help Center
2166+
url_prefix: https://help.mycompany.com
2167+
custom_domain: help.mycompany.com
21662168
schema:
21672169
"$ref": "#/components/schemas/help_center"
21682170
'404':
@@ -14655,7 +14657,9 @@ paths:
1465514657
tags:
1465614658
- Brands
1465714659
operationId: listBrands
14658-
description: Retrieves all brands for the workspace, including the default brand
14660+
description: |
14661+
Retrieves all brands for the workspace, including the default brand.
14662+
The default brand id always matches the workspace
1465914663
parameters:
1466014664
- name: Intercom-Version
1466114665
in: header
@@ -14674,7 +14678,7 @@ paths:
1467414678
type: list
1467514679
data:
1467614680
- type: brand
14677-
id: "2"
14681+
id: "tlkp1d91"
1467814682
name: "Default Brand"
1467914683
is_default: true
1468014684
created_at: 1673778600
@@ -20390,7 +20394,7 @@ components:
2039020394
url_prefix:
2039120395
type: string
2039220396
description: The URL path prefix for the help center
20393-
example: "https://intercom.help/mycompany"
20397+
example: "https://help.mycompany.com"
2039420398
custom_domain:
2039520399
type: string
2039620400
nullable: true

descriptions/2.10/api.intercom.io.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1235,6 +1235,8 @@ paths:
12351235
identifier: help-center-1
12361236
website_turned_on: false
12371237
display_name: Intercom Help Center
1238+
url_prefix: https://help.mycompany.com
1239+
custom_domain: help.mycompany.com
12381240
schema:
12391241
"$ref": "#/components/schemas/help_center"
12401242
'404':
@@ -14870,7 +14872,7 @@ components:
1487014872
url_prefix:
1487114873
type: string
1487214874
description: The URL path prefix for the help center
14873-
example: "https://intercom.help/mycompany"
14875+
example: "https://help.mycompany.com"
1487414876
custom_domain:
1487514877
type: string
1487614878
nullable: true

descriptions/2.11/api.intercom.io.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1263,6 +1263,8 @@ paths:
12631263
identifier: help-center-1
12641264
website_turned_on: false
12651265
display_name: Intercom Help Center
1266+
url_prefix: https://help.mycompany.com
1267+
custom_domain: help.mycompany.com
12661268
schema:
12671269
"$ref": "#/components/schemas/help_center"
12681270
'404':
@@ -15887,7 +15889,7 @@ components:
1588715889
url_prefix:
1588815890
type: string
1588915891
description: The URL path prefix for the help center
15890-
example: "https://intercom.help/mycompany"
15892+
example: "https://help.mycompany.com"
1589115893
custom_domain:
1589215894
type: string
1589315895
nullable: true

descriptions/2.12/api.intercom.io.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1817,6 +1817,8 @@ paths:
18171817
identifier: help-center-1
18181818
website_turned_on: false
18191819
display_name: Intercom Help Center
1820+
url_prefix: https://help.mycompany.com
1821+
custom_domain: help.mycompany.com
18201822
schema:
18211823
"$ref": "#/components/schemas/help_center"
18221824
'404':
@@ -16157,7 +16159,7 @@ components:
1615716159
url_prefix:
1615816160
type: string
1615916161
description: The URL path prefix for the help center
16160-
example: "https://intercom.help/mycompany"
16162+
example: "https://help.mycompany.com"
1616116163
custom_domain:
1616216164
type: string
1616316165
nullable: true

descriptions/2.13/api.intercom.io.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1847,6 +1847,8 @@ paths:
18471847
identifier: help-center-1
18481848
website_turned_on: false
18491849
display_name: Intercom Help Center
1850+
url_prefix: https://help.mycompany.com
1851+
custom_domain: help.mycompany.com
18501852
schema:
18511853
"$ref": "#/components/schemas/help_center"
18521854
'404':
@@ -17872,7 +17874,7 @@ components:
1787217874
url_prefix:
1787317875
type: string
1787417876
description: The URL path prefix for the help center
17875-
example: "https://intercom.help/mycompany"
17877+
example: "https://help.mycompany.com"
1787617878
custom_domain:
1787717879
type: string
1787817880
nullable: true

descriptions/2.14/api.intercom.io.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2163,6 +2163,8 @@ paths:
21632163
identifier: help-center-1
21642164
website_turned_on: false
21652165
display_name: Intercom Help Center
2166+
url_prefix: https://help.mycompany.com
2167+
custom_domain: help.mycompany.com
21662168
schema:
21672169
"$ref": "#/components/schemas/help_center"
21682170
'404':
@@ -19362,7 +19364,7 @@ components:
1936219364
url_prefix:
1936319365
type: string
1936419366
description: The URL path prefix for the help center
19365-
example: "https://intercom.help/mycompany"
19367+
example: "https://help.mycompany.com"
1936619368
custom_domain:
1936719369
type: string
1936819370
nullable: true

descriptions/2.7/api.intercom.io.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1134,6 +1134,8 @@ paths:
11341134
identifier: help-center-1
11351135
website_turned_on: false
11361136
display_name: Intercom Help Center
1137+
url_prefix: https://help.mycompany.com
1138+
custom_domain: help.mycompany.com
11371139
schema:
11381140
"$ref": "#/components/schemas/help_center"
11391141
'404':
@@ -12862,7 +12864,7 @@ components:
1286212864
url_prefix:
1286312865
type: string
1286412866
description: The URL path prefix for the help center
12865-
example: "https://intercom.help/mycompany"
12867+
example: "https://help.mycompany.com"
1286612868
custom_domain:
1286712869
type: string
1286812870
nullable: true

descriptions/2.8/api.intercom.io.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1134,6 +1134,8 @@ paths:
11341134
identifier: help-center-1
11351135
website_turned_on: false
11361136
display_name: Intercom Help Center
1137+
url_prefix: https://help.mycompany.com
1138+
custom_domain: help.mycompany.com
11371139
schema:
11381140
"$ref": "#/components/schemas/help_center"
11391141
'404':
@@ -12886,7 +12888,7 @@ components:
1288612888
url_prefix:
1288712889
type: string
1288812890
description: The URL path prefix for the help center
12889-
example: "https://intercom.help/mycompany"
12891+
example: "https://help.mycompany.com"
1289012892
custom_domain:
1289112893
type: string
1289212894
nullable: true

descriptions/2.9/api.intercom.io.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1134,6 +1134,8 @@ paths:
11341134
identifier: help-center-1
11351135
website_turned_on: false
11361136
display_name: Intercom Help Center
1137+
url_prefix: https://help.mycompany.com
1138+
custom_domain: help.mycompany.com
11371139
schema:
11381140
"$ref": "#/components/schemas/help_center"
11391141
'404':
@@ -14225,7 +14227,7 @@ components:
1422514227
url_prefix:
1422614228
type: string
1422714229
description: The URL path prefix for the help center
14228-
example: "https://intercom.help/mycompany"
14230+
example: "https://help.mycompany.com"
1422914231
custom_domain:
1423014232
type: string
1423114233
nullable: true

0 commit comments

Comments
 (0)