Skip to content

docs: Add clarification for ticket id parameter #372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anubhav-intercom merged 1 commit into from
Feb 18, 2026
Merged

docs: Add clarification for ticket id parameter #372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
18 changes: 15 additions & 3 deletions descriptions/2.10/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
18 changes: 15 additions & 3 deletions descriptions/2.12/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
18 changes: 15 additions & 3 deletions descriptions/2.13/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
18 changes: 15 additions & 3 deletions descriptions/2.14/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
24 changes: 20 additions & 4 deletions descriptions/2.15/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down
18 changes: 15 additions & 3 deletions descriptions/2.9/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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:
Expand Down