Skip to content

Correct the 200 response schema for attaching and detaching a contact #655

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
cox512 merged 4 commits into from
Sep 4, 2026
Merged

Correct the 200 response schema for attaching and detaching a contact #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b75c0c5
Correct the 200 response schema for attach and detach contact
cox512 Sep 2, 2026
9bffc51
Address review: add customers example, drop visitor from contact roles
cox512 Sep 2, 2026
f6732f3
Name the response schema after participants, not customers
cox512 Sep 2, 2026
5d6515b
Revert two unrelated contact-ID descriptions
cox512 Sep 2, 2026
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
32 changes: 30 additions & 2 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14556,7 +14556,7 @@ paths:
- type: user
id: 6762f19b1bb69f9f2193bbd4
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Not found
content:
Expand Down Expand Up @@ -14661,7 +14661,7 @@ paths:
- type: user
id: 6762f1b41bb69f9f2193bbe0
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Contact not found
content:
Expand Down Expand Up @@ -28972,6 +28972,34 @@ components:
"$ref": "#/components/schemas/customer_request"
required:
- email
conversation_participants_response:
title: Conversation Participants Response
type: object
description: The participants of the conversation, returned after attaching
or detaching a contact
properties:
customers:
type: array
description: The conversation participants after the change
items:
type: object
properties:
type:
type: string
description: The role of the participant. Can be "user" or "lead"
example: 'user'
id:
type: string
description: The unique identifier for the participant
example: '6762f1a61bb69f9f2193bbd8'
required:
- type
- id
example:
- type: user
id: '6762f1a61bb69f9f2193bbd8'
required:
- customers
team_metric:
type: object
description: Per-admin activity metrics within a team.
Expand Down
32 changes: 30 additions & 2 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 @@ -5971,7 +5971,7 @@ paths:
- type: user
id: 6657accd6abd0166b52ae296
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Not found
content:
Expand Down Expand Up @@ -6076,7 +6076,7 @@ paths:
- type: user
id: 6657acdb6abd0166b52ae2a2
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Contact not found
content:
Expand Down Expand Up @@ -11937,6 +11937,34 @@ components:
"$ref": "#/components/schemas/customer_request"
required:
- email
conversation_participants_response:
title: Conversation Participants Response
type: object
description: The participants of the conversation, returned after attaching
or detaching a contact
properties:
customers:
type: array
description: The conversation participants after the change
items:
type: object
properties:
type:
type: string
description: The role of the participant. Can be "user" or "lead"
example: 'user'
id:
type: string
description: The unique identifier for the participant
example: '6762f1a61bb69f9f2193bbd8'
required:
- type
- id
example:
- type: user
id: '6762f1a61bb69f9f2193bbd8'
required:
- customers
close_conversation_request:
title: Close Conversation Request
type: object
Expand Down
32 changes: 30 additions & 2 deletions descriptions/2.11/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6081,7 +6081,7 @@ paths:
- type: user
id: 667d61168a68186f43bafe0d
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Not found
content:
Expand Down Expand Up @@ -6186,7 +6186,7 @@ paths:
- type: user
id: 667d61228a68186f43bafe19
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Contact not found
content:
Expand Down Expand Up @@ -12179,6 +12179,34 @@ components:
nullable: true
required:
- email
conversation_participants_response:
title: Conversation Participants Response
type: object
description: The participants of the conversation, returned after attaching
or detaching a contact
properties:
customers:
type: array
description: The conversation participants after the change
items:
type: object
properties:
type:
type: string
description: The role of the participant. Can be "user" or "lead"
example: 'user'
id:
type: string
description: The unique identifier for the participant
example: '6762f1a61bb69f9f2193bbd8'
required:
- type
- id
example:
- type: user
id: '6762f1a61bb69f9f2193bbd8'
required:
- customers
button_component:
title: Button Component
type: object
Expand Down
32 changes: 30 additions & 2 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 @@ -6491,7 +6491,7 @@ paths:
- type: user
id: 677c55ef6abd011ad17ff541
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Not found
content:
Expand Down Expand Up @@ -6596,7 +6596,7 @@ paths:
- type: user
id: 677c56016abd011ad17ff54d
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Contact not found
content:
Expand Down Expand Up @@ -12843,6 +12843,34 @@ components:
"$ref": "#/components/schemas/customer_request"
required:
- email
conversation_participants_response:
title: Conversation Participants Response
type: object
description: The participants of the conversation, returned after attaching
or detaching a contact
properties:
customers:
type: array
description: The conversation participants after the change
items:
type: object
properties:
type:
type: string
description: The role of the participant. Can be "user" or "lead"
example: 'user'
id:
type: string
description: The unique identifier for the participant
example: '6762f1a61bb69f9f2193bbd8'
required:
- type
- id
example:
- type: user
id: '6762f1a61bb69f9f2193bbd8'
required:
- customers
close_conversation_request:
title: Close Conversation Request
type: object
Expand Down
32 changes: 30 additions & 2 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 @@ -7476,7 +7476,7 @@ paths:
- type: user
id: 677c55ef6abd011ad17ff541
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Not found
content:
Expand Down Expand Up @@ -7581,7 +7581,7 @@ paths:
- type: user
id: 677c56016abd011ad17ff54d
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Contact not found
content:
Expand Down Expand Up @@ -14294,6 +14294,34 @@ components:
"$ref": "#/components/schemas/customer_request"
required:
- email
conversation_participants_response:
title: Conversation Participants Response
type: object
description: The participants of the conversation, returned after attaching
or detaching a contact
properties:
customers:
type: array
description: The conversation participants after the change
items:
type: object
properties:
type:
type: string
description: The role of the participant. Can be "user" or "lead"
example: 'user'
id:
type: string
description: The unique identifier for the participant
example: '6762f1a61bb69f9f2193bbd8'
required:
- type
- id
example:
- type: user
id: '6762f1a61bb69f9f2193bbd8'
required:
- customers
close_conversation_request:
title: Close Conversation Request
type: object
Expand Down
32 changes: 30 additions & 2 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 @@ -8459,7 +8459,7 @@ paths:
- type: user
id: 6762f19b1bb69f9f2193bbd4
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Not found
content:
Expand Down Expand Up @@ -8564,7 +8564,7 @@ paths:
- type: user
id: 6762f1b41bb69f9f2193bbe0
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Contact not found
content:
Expand Down Expand Up @@ -15951,6 +15951,34 @@ components:
"$ref": "#/components/schemas/customer_request"
required:
- email
conversation_participants_response:
title: Conversation Participants Response
type: object
description: The participants of the conversation, returned after attaching
or detaching a contact
properties:
customers:
type: array
description: The conversation participants after the change
items:
type: object
properties:
type:
type: string
description: The role of the participant. Can be "user" or "lead"
example: 'user'
id:
type: string
description: The unique identifier for the participant
example: '6762f1a61bb69f9f2193bbd8'
required:
- type
- id
example:
- type: user
id: '6762f1a61bb69f9f2193bbd8'
required:
- customers
away_status_reason:
type: object
properties:
Expand Down
32 changes: 30 additions & 2 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 @@ -8382,7 +8382,7 @@ paths:
- type: user
id: 6762f19b1bb69f9f2193bbd4
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Not found
content:
Expand Down Expand Up @@ -8487,7 +8487,7 @@ paths:
- type: user
id: 6762f1b41bb69f9f2193bbe0
schema:
"$ref": "#/components/schemas/conversation"
"$ref": "#/components/schemas/conversation_participants_response"
'404':
description: Contact not found
content:
Expand Down Expand Up @@ -16636,6 +16636,34 @@ components:
"$ref": "#/components/schemas/customer_request"
required:
- email
conversation_participants_response:
title: Conversation Participants Response
type: object
description: The participants of the conversation, returned after attaching
or detaching a contact
properties:
customers:
type: array
description: The conversation participants after the change
items:
type: object
properties:
type:
type: string
description: The role of the participant. Can be "user" or "lead"
example: 'user'
id:
type: string
description: The unique identifier for the participant
example: '6762f1a61bb69f9f2193bbd8'
required:
- type
- id
example:
- type: user
id: '6762f1a61bb69f9f2193bbd8'
required:
- customers
brand:
type: object
title: Brand
Expand Down
Loading