From c948ac0b582b21851541488ff04d3ad16c8b498b Mon Sep 17 00:00:00 2001 From: Mark Dennis Date: Tue, 7 Apr 2026 10:45:02 +0100 Subject: [PATCH] Add missing examples to create_contact_request schema MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The create contact request body was missing example values for the role, external_id, and custom_attributes fields, making it unclear to customers what values to provide. Other endpoints like create company already had complete examples. This adds examples to all three fields across all API versions (2.7–2.15 and Unstable). Co-Authored-By: Claude Opus 4.6 (1M context) --- descriptions/0/api.intercom.io.yaml | 6 ++++++ descriptions/2.10/api.intercom.io.yaml | 6 ++++++ descriptions/2.11/api.intercom.io.yaml | 6 ++++++ descriptions/2.12/api.intercom.io.yaml | 6 ++++++ descriptions/2.13/api.intercom.io.yaml | 6 ++++++ descriptions/2.14/api.intercom.io.yaml | 6 ++++++ descriptions/2.15/api.intercom.io.yaml | 6 ++++++ descriptions/2.7/api.intercom.io.yaml | 6 ++++++ descriptions/2.8/api.intercom.io.yaml | 6 ++++++ descriptions/2.9/api.intercom.io.yaml | 6 ++++++ 10 files changed, 60 insertions(+) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 0764490..60b589b 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -21830,9 +21830,11 @@ components: role: type: string description: The role of the contact. + example: user external_id: type: string description: A unique identifier for the contact which is given to Intercom + example: "625e90fc55ab113b6d92175f" email: type: string description: The contacts email @@ -21888,6 +21890,10 @@ components: type: object nullable: true description: The custom attributes which are set for the contact + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 1 anyOf: - required: - email diff --git a/descriptions/2.10/api.intercom.io.yaml b/descriptions/2.10/api.intercom.io.yaml index 5e6499c..dacfe27 100644 --- a/descriptions/2.10/api.intercom.io.yaml +++ b/descriptions/2.10/api.intercom.io.yaml @@ -13650,9 +13650,11 @@ components: role: type: string description: The role of the contact. + example: user external_id: type: string description: A unique identifier for the contact which is given to Intercom + example: "625e90fc55ab113b6d92175f" email: type: string description: The contacts email @@ -13700,6 +13702,10 @@ components: type: object nullable: true description: The custom attributes which are set for the contact + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 1 anyOf: - required: - email diff --git a/descriptions/2.11/api.intercom.io.yaml b/descriptions/2.11/api.intercom.io.yaml index 58f983b..24615ab 100644 --- a/descriptions/2.11/api.intercom.io.yaml +++ b/descriptions/2.11/api.intercom.io.yaml @@ -14459,9 +14459,11 @@ components: role: type: string description: The role of the contact. + example: user external_id: type: string description: A unique identifier for the contact which is given to Intercom + example: "625e90fc55ab113b6d92175f" email: type: string description: The contacts email @@ -14509,6 +14511,10 @@ components: type: object nullable: true description: The custom attributes which are set for the contact + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 1 anyOf: - required: - email diff --git a/descriptions/2.12/api.intercom.io.yaml b/descriptions/2.12/api.intercom.io.yaml index e2afe89..e6c95eb 100644 --- a/descriptions/2.12/api.intercom.io.yaml +++ b/descriptions/2.12/api.intercom.io.yaml @@ -14721,9 +14721,11 @@ components: role: type: string description: The role of the contact. + example: user external_id: type: string description: A unique identifier for the contact which is given to Intercom + example: "625e90fc55ab113b6d92175f" email: type: string description: The contacts email @@ -14771,6 +14773,10 @@ components: type: object nullable: true description: The custom attributes which are set for the contact + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 1 anyOf: - required: - email diff --git a/descriptions/2.13/api.intercom.io.yaml b/descriptions/2.13/api.intercom.io.yaml index 1e29d16..5e16da4 100644 --- a/descriptions/2.13/api.intercom.io.yaml +++ b/descriptions/2.13/api.intercom.io.yaml @@ -16156,9 +16156,11 @@ components: role: type: string description: The role of the contact. + example: user external_id: type: string description: A unique identifier for the contact which is given to Intercom + example: "625e90fc55ab113b6d92175f" email: type: string description: The contacts email @@ -16206,6 +16208,10 @@ components: type: object nullable: true description: The custom attributes which are set for the contact + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 1 anyOf: - required: - email diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index 6c74b43..d8c3cd3 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -17604,9 +17604,11 @@ components: role: type: string description: The role of the contact. + example: user external_id: type: string description: A unique identifier for the contact which is given to Intercom + example: "625e90fc55ab113b6d92175f" email: type: string description: The contacts email @@ -17654,6 +17656,10 @@ components: type: object nullable: true description: The custom attributes which are set for the contact + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 1 anyOf: - required: - email diff --git a/descriptions/2.15/api.intercom.io.yaml b/descriptions/2.15/api.intercom.io.yaml index 98cb824..f54a666 100644 --- a/descriptions/2.15/api.intercom.io.yaml +++ b/descriptions/2.15/api.intercom.io.yaml @@ -18331,9 +18331,11 @@ components: role: type: string description: The role of the contact. + example: user external_id: type: string description: A unique identifier for the contact which is given to Intercom + example: "625e90fc55ab113b6d92175f" email: type: string description: The contacts email @@ -18381,6 +18383,10 @@ components: type: object nullable: true description: The custom attributes which are set for the contact + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 1 anyOf: - required: - email diff --git a/descriptions/2.7/api.intercom.io.yaml b/descriptions/2.7/api.intercom.io.yaml index 66b6403..29f012f 100644 --- a/descriptions/2.7/api.intercom.io.yaml +++ b/descriptions/2.7/api.intercom.io.yaml @@ -11744,9 +11744,11 @@ components: role: type: string description: The role of the contact. + example: user external_id: type: string description: A unique identifier for the contact which is given to Intercom + example: "625e90fc55ab113b6d92175f" email: type: string description: The contacts email @@ -11794,6 +11796,10 @@ components: type: object nullable: true description: The custom attributes which are set for the contact + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 1 anyOf: - required: - email diff --git a/descriptions/2.8/api.intercom.io.yaml b/descriptions/2.8/api.intercom.io.yaml index 5ebe4e0..47fb48d 100644 --- a/descriptions/2.8/api.intercom.io.yaml +++ b/descriptions/2.8/api.intercom.io.yaml @@ -11768,9 +11768,11 @@ components: role: type: string description: The role of the contact. + example: user external_id: type: string description: A unique identifier for the contact which is given to Intercom + example: "625e90fc55ab113b6d92175f" email: type: string description: The contacts email @@ -11818,6 +11820,10 @@ components: type: object nullable: true description: The custom attributes which are set for the contact + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 1 anyOf: - required: - email diff --git a/descriptions/2.9/api.intercom.io.yaml b/descriptions/2.9/api.intercom.io.yaml index 8aac054..3a454fa 100644 --- a/descriptions/2.9/api.intercom.io.yaml +++ b/descriptions/2.9/api.intercom.io.yaml @@ -12948,9 +12948,11 @@ components: role: type: string description: The role of the contact. + example: user external_id: type: string description: A unique identifier for the contact which is given to Intercom + example: "625e90fc55ab113b6d92175f" email: type: string description: The contacts email @@ -12998,6 +13000,10 @@ components: type: object nullable: true description: The custom attributes which are set for the contact + example: + paid_subscriber: true + monthly_spend: 155.5 + team_mates: 1 anyOf: - required: - email