Skip to content

Document the contact identifiers accepted when creating a conversation #749

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
yasser-aboelgheit-intercom merged 4 commits into from
Oct 27, 2026
Merged

Document the contact identifiers accepted when creating a conversation #749

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
b56c634
Document the contact identifiers accepted when creating a conversation
yasser-aboelgheit-intercom Oct 21, 2026
fdd1c6e
Clarify which contact identifiers match users and leads
yasser-aboelgheit-intercom Oct 21, 2026
b4bf471
Say which contact identifier is used when more than one is sent
yasser-aboelgheit-intercom Oct 21, 2026
575f5d9
Keep contact as an accepted from type
yasser-aboelgheit-intercom Oct 22, 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
16 changes: 14 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 @@ -37326,13 +37326,25 @@ components:
id:
type: string
description: The identifier for the contact which is given by Intercom.
format: uuid
Provide one of `id`, `user_id` or `email`. If you send more than one,
`id` is used first, then `user_id`.
minLength: 24
maxLength: 24
example: 536e564f316c83104c000020
user_id:
type: string
description: The external identifier you gave the user. Matches users only;
for a lead, use `id` or `email`.
example: '25'
email:
type: string
description: The contact's email. Matches a user or a lead, depending on
`type`. Used only when `user_id` isn't sent. If several leads share the
email and it's the only identifier sent, the request fails with
`multiple_users`; use `id` instead.
example: joe@example.com
required:
- type
- id
body:
type: string
description: The content of the message. HTML is not supported.
Expand Down
16 changes: 14 additions & 2 deletions descriptions/2.17/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32821,13 +32821,25 @@ components:
id:
type: string
description: The identifier for the contact which is given by Intercom.
format: uuid
Provide one of `id`, `user_id` or `email`. If you send more than one,
`id` is used first, then `user_id`.
minLength: 24
maxLength: 24
example: 536e564f316c83104c000020
user_id:
type: string
description: The external identifier you gave the user. Matches users only;
for a lead, use `id` or `email`.
example: '25'
email:
type: string
description: The contact's email. Matches a user or a lead, depending on
`type`. Used only when `user_id` isn't sent. If several leads share the
email and it's the only identifier sent, the request fails with
`multiple_users`; use `id` instead.
example: joe@example.com
required:
- type
- id
body:
type: string
description: The content of the message. HTML is not supported.
Expand Down
Loading