Skip to content

Commit 890fabb

Browse files
anubhav-intercomclaude
anubhav-intercom
and
claude
committed
docs: Add clarification for ticket id parameter
Add info admonition to ticket endpoint parameter descriptions clarifying that the id parameter is the internal API id, not the ticket_id displayed in the Intercom Inbox. This mirrors the changes in developer-docs PR #720. Affected versions: 2.9, 2.10, 2.12, 2.13, 2.14, 2.15, and Unstable (0). Endpoints modified: GET, PUT, DELETE (where applicable), and Reply. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 1c14a2a commit 890fabb

File tree

7 files changed

+125
-25
lines changed

7 files changed

+125
-25
lines changed

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

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13299,7 +13299,11 @@ paths:
1329913299
schema:
1330013300
title: Ticket ID
1330113301
type: string
13302-
description: The id of the ticket to target.
13302+
description: |
13303+
The id of the ticket to target.
13304+
{% admonition type="info" name="Not the Inbox ticket ID" %}
13305+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
13306+
{% /admonition %}
1330313307
example: '123'
1330413308
tags:
1330513309
- Tickets
@@ -13889,7 +13893,11 @@ paths:
1388913893
- name: id
1389013894
in: path
1389113895
required: true
13892-
description: The unique identifier for the ticket which is given by Intercom
13896+
description: |
13897+
The unique identifier for the ticket which is given by Intercom.
13898+
{% admonition type="info" name="Not the Inbox ticket ID" %}
13899+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
13900+
{% /admonition %}
1389313901
schema:
1389413902
type: string
1389513903
tags:
@@ -14185,7 +14193,11 @@ paths:
1418514193
- name: id
1418614194
in: path
1418714195
required: true
14188-
description: The unique identifier for the ticket which is given by Intercom.
14196+
description: |
14197+
The unique identifier for the ticket which is given by Intercom.
14198+
{% admonition type="info" name="Not the Inbox ticket ID" %}
14199+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
14200+
{% /admonition %}
1418914201
schema:
1419014202
type: string
1419114203
tags:
@@ -14324,7 +14336,11 @@ paths:
1432414336
- name: id
1432514337
in: path
1432614338
required: true
14327-
description: The unique identifier for the ticket which is given by Intercom.
14339+
description: |
14340+
The unique identifier for the ticket which is given by Intercom.
14341+
{% admonition type="info" name="Not the Inbox ticket ID" %}
14342+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
14343+
{% /admonition %}
1432814344
schema:
1432914345
type: string
1433014346
tags:

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

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9364,7 +9364,11 @@ paths:
93649364
schema:
93659365
title: Ticket ID
93669366
type: string
9367-
description: The id of the ticket to target.
9367+
description: |
9368+
The id of the ticket to target.
9369+
{% admonition type="info" name="Not the Inbox ticket ID" %}
9370+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
9371+
{% /admonition %}
93689372
example: '123'
93699373
tags:
93709374
- Tickets
@@ -9861,7 +9865,11 @@ paths:
98619865
- name: id
98629866
in: path
98639867
required: true
9864-
description: The unique identifier for the ticket which is given by Intercom
9868+
description: |
9869+
The unique identifier for the ticket which is given by Intercom.
9870+
{% admonition type="info" name="Not the Inbox ticket ID" %}
9871+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
9872+
{% /admonition %}
98659873
schema:
98669874
type: string
98679875
tags:
@@ -10119,7 +10127,11 @@ paths:
1011910127
- name: id
1012010128
in: path
1012110129
required: true
10122-
description: The unique identifier for the ticket which is given by Intercom.
10130+
description: |
10131+
The unique identifier for the ticket which is given by Intercom.
10132+
{% admonition type="info" name="Not the Inbox ticket ID" %}
10133+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
10134+
{% /admonition %}
1012310135
schema:
1012410136
type: string
1012510137
tags:

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

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10158,7 +10158,11 @@ paths:
1015810158
schema:
1015910159
title: Ticket ID
1016010160
type: string
10161-
description: The id of the ticket to target.
10161+
description: |
10162+
The id of the ticket to target.
10163+
{% admonition type="info" name="Not the Inbox ticket ID" %}
10164+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
10165+
{% /admonition %}
1016210166
example: '123'
1016310167
tags:
1016410168
- Tickets
@@ -10657,7 +10661,11 @@ paths:
1065710661
- name: id
1065810662
in: path
1065910663
required: true
10660-
description: The unique identifier for the ticket which is given by Intercom
10664+
description: |
10665+
The unique identifier for the ticket which is given by Intercom.
10666+
{% admonition type="info" name="Not the Inbox ticket ID" %}
10667+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
10668+
{% /admonition %}
1066110669
schema:
1066210670
type: string
1066310671
tags:
@@ -10937,7 +10945,11 @@ paths:
1093710945
- name: id
1093810946
in: path
1093910947
required: true
10940-
description: The unique identifier for the ticket which is given by Intercom.
10948+
description: |
10949+
The unique identifier for the ticket which is given by Intercom.
10950+
{% admonition type="info" name="Not the Inbox ticket ID" %}
10951+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
10952+
{% /admonition %}
1094110953
schema:
1094210954
type: string
1094310955
tags:

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

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11388,7 +11388,11 @@ paths:
1138811388
schema:
1138911389
title: Ticket ID
1139011390
type: string
11391-
description: The id of the ticket to target.
11391+
description: |
11392+
The id of the ticket to target.
11393+
{% admonition type="info" name="Not the Inbox ticket ID" %}
11394+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
11395+
{% /admonition %}
1139211396
example: '123'
1139311397
tags:
1139411398
- Tickets
@@ -11900,7 +11904,11 @@ paths:
1190011904
- name: id
1190111905
in: path
1190211906
required: true
11903-
description: The unique identifier for the ticket which is given by Intercom
11907+
description: |
11908+
The unique identifier for the ticket which is given by Intercom.
11909+
{% admonition type="info" name="Not the Inbox ticket ID" %}
11910+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
11911+
{% /admonition %}
1190411912
schema:
1190511913
type: string
1190611914
tags:
@@ -12181,7 +12189,11 @@ paths:
1218112189
- name: id
1218212190
in: path
1218312191
required: true
12184-
description: The unique identifier for the ticket which is given by Intercom.
12192+
description: |
12193+
The unique identifier for the ticket which is given by Intercom.
12194+
{% admonition type="info" name="Not the Inbox ticket ID" %}
12195+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
12196+
{% /admonition %}
1218512197
schema:
1218612198
type: string
1218712199
tags:
@@ -12320,7 +12332,11 @@ paths:
1232012332
- name: id
1232112333
in: path
1232212334
required: true
12323-
description: The unique identifier for the ticket which is given by Intercom.
12335+
description: |
12336+
The unique identifier for the ticket which is given by Intercom.
12337+
{% admonition type="info" name="Not the Inbox ticket ID" %}
12338+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
12339+
{% /admonition %}
1232412340
schema:
1232512341
type: string
1232612342
tags:

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

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12464,7 +12464,11 @@ paths:
1246412464
schema:
1246512465
title: Ticket ID
1246612466
type: string
12467-
description: The id of the ticket to target.
12467+
description: |
12468+
The id of the ticket to target.
12469+
{% admonition type="info" name="Not the Inbox ticket ID" %}
12470+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
12471+
{% /admonition %}
1246812472
example: '123'
1246912473
tags:
1247012474
- Tickets
@@ -13054,7 +13058,11 @@ paths:
1305413058
- name: ticket_id
1305513059
in: path
1305613060
required: true
13057-
description: The unique identifier for the ticket which is given by Intercom
13061+
description: |
13062+
The unique identifier for the ticket which is given by Intercom.
13063+
{% admonition type="info" name="Not the Inbox ticket ID" %}
13064+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
13065+
{% /admonition %}
1305813066
schema:
1305913067
type: string
1306013068
tags:
@@ -13350,7 +13358,11 @@ paths:
1335013358
- name: ticket_id
1335113359
in: path
1335213360
required: true
13353-
description: The unique identifier for the ticket which is given by Intercom.
13361+
description: |
13362+
The unique identifier for the ticket which is given by Intercom.
13363+
{% admonition type="info" name="Not the Inbox ticket ID" %}
13364+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
13365+
{% /admonition %}
1335413366
schema:
1335513367
type: string
1335613368
tags:
@@ -13489,7 +13501,11 @@ paths:
1348913501
- name: ticket_id
1349013502
in: path
1349113503
required: true
13492-
description: The unique identifier for the ticket which is given by Intercom.
13504+
description: |
13505+
The unique identifier for the ticket which is given by Intercom.
13506+
{% admonition type="info" name="Not the Inbox ticket ID" %}
13507+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
13508+
{% /admonition %}
1349313509
schema:
1349413510
type: string
1349513511
tags:

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

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12535,7 +12535,11 @@ paths:
1253512535
schema:
1253612536
title: Ticket ID
1253712537
type: string
12538-
description: The id of the ticket to target.
12538+
description: |
12539+
The id of the ticket to target.
12540+
{% admonition type="info" name="Not the Inbox ticket ID" %}
12541+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
12542+
{% /admonition %}
1253912543
example: '123'
1254012544
tags:
1254112545
- Tickets
@@ -13125,7 +13129,11 @@ paths:
1312513129
- name: ticket_id
1312613130
in: path
1312713131
required: true
13128-
description: The unique identifier for the ticket which is given by Intercom
13132+
description: |
13133+
The unique identifier for the ticket which is given by Intercom.
13134+
{% admonition type="info" name="Not the Inbox ticket ID" %}
13135+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
13136+
{% /admonition %}
1312913137
schema:
1313013138
type: string
1313113139
tags:
@@ -13421,7 +13429,11 @@ paths:
1342113429
- name: ticket_id
1342213430
in: path
1342313431
required: true
13424-
description: The unique identifier for the ticket which is given by Intercom.
13432+
description: |
13433+
The unique identifier for the ticket which is given by Intercom.
13434+
{% admonition type="info" name="Not the Inbox ticket ID" %}
13435+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
13436+
{% /admonition %}
1342513437
schema:
1342613438
type: string
1342713439
tags:
@@ -13560,7 +13572,11 @@ paths:
1356013572
- name: ticket_id
1356113573
in: path
1356213574
required: true
13563-
description: The unique identifier for the ticket which is given by Intercom.
13575+
description: |
13576+
The unique identifier for the ticket which is given by Intercom.
13577+
{% admonition type="info" name="Not the Inbox ticket ID" %}
13578+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
13579+
{% /admonition %}
1356413580
schema:
1356513581
type: string
1356613582
tags:

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

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9356,7 +9356,11 @@ paths:
93569356
schema:
93579357
title: Ticket ID
93589358
type: string
9359-
description: The id of the ticket to target.
9359+
description: |
9360+
The id of the ticket to target.
9361+
{% admonition type="info" name="Not the Inbox ticket ID" %}
9362+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
9363+
{% /admonition %}
93609364
example: '123'
93619365
tags:
93629366
- Tickets
@@ -9570,7 +9574,11 @@ paths:
95709574
- name: id
95719575
in: path
95729576
required: true
9573-
description: The unique identifier for the ticket which is given by Intercom
9577+
description: |
9578+
The unique identifier for the ticket which is given by Intercom.
9579+
{% admonition type="info" name="Not the Inbox ticket ID" %}
9580+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
9581+
{% /admonition %}
95749582
schema:
95759583
type: string
95769584
tags:
@@ -9804,7 +9812,11 @@ paths:
98049812
- name: id
98059813
in: path
98069814
required: true
9807-
description: The unique identifier for the ticket which is given by Intercom.
9815+
description: |
9816+
The unique identifier for the ticket which is given by Intercom.
9817+
{% admonition type="info" name="Not the Inbox ticket ID" %}
9818+
This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API.
9819+
{% /admonition %}
98089820
schema:
98099821
type: string
98109822
tags:

0 commit comments

Comments
 (0)