From 15431916b2a4ba1db106942565283793afaf53b8 Mon Sep 17 00:00:00 2001 From: anubhav-intercom Date: Tue, 17 Feb 2026 14:49:00 +0000 Subject: [PATCH] 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, Reply (all versions), DELETE (2.15, Unstable). Co-Authored-By: Claude Opus 4.6 (1M context) --- descriptions/0/api.intercom.io.yaml | 24 ++++++++++++++++++++---- descriptions/2.10/api.intercom.io.yaml | 18 +++++++++++++++--- descriptions/2.12/api.intercom.io.yaml | 18 +++++++++++++++--- descriptions/2.13/api.intercom.io.yaml | 18 +++++++++++++++--- descriptions/2.14/api.intercom.io.yaml | 18 +++++++++++++++--- descriptions/2.15/api.intercom.io.yaml | 24 ++++++++++++++++++++---- descriptions/2.9/api.intercom.io.yaml | 18 +++++++++++++++--- 7 files changed, 115 insertions(+), 23 deletions(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 7b102a9..2a79404 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -13299,7 +13299,11 @@ paths: schema: title: Ticket ID type: string - description: The id of the ticket to target. + description: | + The id of the ticket to target. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} example: '123' tags: - Tickets @@ -13889,7 +13893,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: @@ -14185,7 +14193,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom. + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: @@ -14324,7 +14336,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom. + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: diff --git a/descriptions/2.10/api.intercom.io.yaml b/descriptions/2.10/api.intercom.io.yaml index 1a23b9f..3c488d7 100644 --- a/descriptions/2.10/api.intercom.io.yaml +++ b/descriptions/2.10/api.intercom.io.yaml @@ -9364,7 +9364,11 @@ paths: schema: title: Ticket ID type: string - description: The id of the ticket to target. + description: | + The id of the ticket to target. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} example: '123' tags: - Tickets @@ -9861,7 +9865,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: @@ -10119,7 +10127,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom. + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: diff --git a/descriptions/2.12/api.intercom.io.yaml b/descriptions/2.12/api.intercom.io.yaml index e9dd3ee..be6312a 100644 --- a/descriptions/2.12/api.intercom.io.yaml +++ b/descriptions/2.12/api.intercom.io.yaml @@ -10158,7 +10158,11 @@ paths: schema: title: Ticket ID type: string - description: The id of the ticket to target. + description: | + The id of the ticket to target. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} example: '123' tags: - Tickets @@ -10657,7 +10661,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: @@ -10937,7 +10945,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom. + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: diff --git a/descriptions/2.13/api.intercom.io.yaml b/descriptions/2.13/api.intercom.io.yaml index 01a7a6c..2f19507 100644 --- a/descriptions/2.13/api.intercom.io.yaml +++ b/descriptions/2.13/api.intercom.io.yaml @@ -11388,7 +11388,11 @@ paths: schema: title: Ticket ID type: string - description: The id of the ticket to target. + description: | + The id of the ticket to target. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} example: '123' tags: - Tickets @@ -11900,7 +11904,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: @@ -12181,7 +12189,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom. + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index d8d7cb1..92ad609 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -12464,7 +12464,11 @@ paths: schema: title: Ticket ID type: string - description: The id of the ticket to target. + description: | + The id of the ticket to target. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} example: '123' tags: - Tickets @@ -13054,7 +13058,11 @@ paths: - name: ticket_id in: path required: true - description: The unique identifier for the ticket which is given by Intercom + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: @@ -13350,7 +13358,11 @@ paths: - name: ticket_id in: path required: true - description: The unique identifier for the ticket which is given by Intercom. + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: diff --git a/descriptions/2.15/api.intercom.io.yaml b/descriptions/2.15/api.intercom.io.yaml index 95302e1..0009ab9 100644 --- a/descriptions/2.15/api.intercom.io.yaml +++ b/descriptions/2.15/api.intercom.io.yaml @@ -12535,7 +12535,11 @@ paths: schema: title: Ticket ID type: string - description: The id of the ticket to target. + description: | + The id of the ticket to target. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} example: '123' tags: - Tickets @@ -13125,7 +13129,11 @@ paths: - name: ticket_id in: path required: true - description: The unique identifier for the ticket which is given by Intercom + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: @@ -13421,7 +13429,11 @@ paths: - name: ticket_id in: path required: true - description: The unique identifier for the ticket which is given by Intercom. + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: @@ -13560,7 +13572,11 @@ paths: - name: ticket_id in: path required: true - description: The unique identifier for the ticket which is given by Intercom. + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: diff --git a/descriptions/2.9/api.intercom.io.yaml b/descriptions/2.9/api.intercom.io.yaml index a165fa7..f6b68f9 100644 --- a/descriptions/2.9/api.intercom.io.yaml +++ b/descriptions/2.9/api.intercom.io.yaml @@ -9356,7 +9356,11 @@ paths: schema: title: Ticket ID type: string - description: The id of the ticket to target. + description: | + The id of the ticket to target. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} example: '123' tags: - Tickets @@ -9570,7 +9574,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: @@ -9804,7 +9812,11 @@ paths: - name: id in: path required: true - description: The unique identifier for the ticket which is given by Intercom. + description: | + The unique identifier for the ticket which is given by Intercom. + {% admonition type="info" name="Not the Inbox ticket ID" %} + 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. + {% /admonition %} schema: type: string tags: