From 165d9faccc6bba10fec1564d76578fd173ef5113 Mon Sep 17 00:00:00 2001 From: ellicenelson Date: Mon, 13 Apr 2026 16:01:56 +0100 Subject: [PATCH] Document CX Score attributes in custom_attributes schema The "CX Score rating" and "CX Score explanation" conversation attributes are already returned in the API but were not mentioned in the OpenAPI spec. This adds them to the custom_attributes description and examples across versions 2.13, 2.14, 2.15, and Preview. Closes intercom/intercom#433818 Co-Authored-By: Claude Opus 4.6 (1M context) --- descriptions/0/api.intercom.io.yaml | 6 +++++- descriptions/2.13/api.intercom.io.yaml | 3 ++- descriptions/2.14/api.intercom.io.yaml | 6 +++++- descriptions/2.15/api.intercom.io.yaml | 6 +++++- 4 files changed, 17 insertions(+), 4 deletions(-) diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index 2f5179b..a57139b 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -22889,7 +22889,8 @@ components: type: object description: An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value - will be a list of custom object instance models. + will be a list of custom object instance models. System-defined attributes + such as "CX Score rating" and "CX Score explanation" may also be included. additionalProperties: anyOf: - type: string @@ -22902,6 +22903,9 @@ components: team_mates: 9 start_date_iso8601: "2023-03-04T09:46:14Z" end_date_timestamp: 1677923174 + CX Score rating: 4 + CX Score explanation: The conversation was resolved quickly and the customer + expressed satisfaction with the outcome. custom_object_instance: title: Custom Object Instance type: object diff --git a/descriptions/2.13/api.intercom.io.yaml b/descriptions/2.13/api.intercom.io.yaml index b3221e5..b5e8f99 100644 --- a/descriptions/2.13/api.intercom.io.yaml +++ b/descriptions/2.13/api.intercom.io.yaml @@ -16933,7 +16933,8 @@ components: type: object description: An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value - will be a list of custom object instance models. + will be a list of custom object instance models. System-defined attributes + such as "CX Score rating" and "CX Score explanation" may also be included. additionalProperties: anyOf: - type: string diff --git a/descriptions/2.14/api.intercom.io.yaml b/descriptions/2.14/api.intercom.io.yaml index 7c4edff..19bb379 100644 --- a/descriptions/2.14/api.intercom.io.yaml +++ b/descriptions/2.14/api.intercom.io.yaml @@ -18593,7 +18593,8 @@ components: type: object description: An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value - will be a list of custom object instance models. + will be a list of custom object instance models. System-defined attributes + such as "CX Score rating" and "CX Score explanation" may also be included. additionalProperties: anyOf: - type: string @@ -18606,6 +18607,9 @@ components: team_mates: 9 start_date_iso8601: "2023-03-04T09:46:14Z" end_date_timestamp: 1677923174 + CX Score rating: 4 + CX Score explanation: The conversation was resolved quickly and the customer + expressed satisfaction with the outcome. custom_object_instance: title: Custom Object Instance type: object diff --git a/descriptions/2.15/api.intercom.io.yaml b/descriptions/2.15/api.intercom.io.yaml index 58ff9df..5dcf628 100644 --- a/descriptions/2.15/api.intercom.io.yaml +++ b/descriptions/2.15/api.intercom.io.yaml @@ -19320,7 +19320,8 @@ components: type: object description: An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value - will be a list of custom object instance models. + will be a list of custom object instance models. System-defined attributes + such as "CX Score rating" and "CX Score explanation" may also be included. additionalProperties: anyOf: - type: string @@ -19333,6 +19334,9 @@ components: team_mates: 9 start_date_iso8601: "2023-03-04T09:46:14Z" end_date_timestamp: 1677923174 + CX Score rating: 4 + CX Score explanation: The conversation was resolved quickly and the customer + expressed satisfaction with the outcome. custom_object_instance: title: Custom Object Instance type: object