Skip to content

Align four shared 2.17 and Preview schemas with what the API sends #761

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

Open
markdennis22 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Align four shared 2.17 and Preview schemas with what the API sends #761

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2dc63ce
Align four shared 2.17 schemas with what the API sends
markdennis22 Oct 22, 2026
fa3b70f
Port the four shared schema changes to Preview
markdennis22 Oct 23, 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
53 changes: 43 additions & 10 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30897,11 +30897,21 @@ components:
items:
type: integer
avatar:
type: string
format: uri
type: object
nullable: true
description: Image for the associated team or teammate
example: https://picsum.photos/200/300
description: The teammate's avatar image. Left out when the teammate has
neither an uploaded avatar nor a gravatar.
properties:
type:
type: string
description: Value is `avatar`. Returned on the admin endpoints only.
example: avatar
image_url:
type: string
format: uri
nullable: true
description: The URL of the avatar image.
example: https://picsum.photos/200/300
team_priority_level:
"$ref": "#/components/schemas/team_priority_level"
role:
Expand Down Expand Up @@ -39047,9 +39057,21 @@ components:
example: Order
custom_attributes:
type: object
description: The custom attributes you have set on the custom object instance.
description: |-
The custom attributes you have set on the custom object instance.

Each value is returned with the type of the attribute it is set on: a string, integer, number or boolean, or `null` when the attribute is unset. A list attribute returns the label of the selected option. A reference attribute returns an object holding the referenced records, under `contacts` for a contact reference, `conversations` for a conversation reference, or `instances` for a reference to another custom object type.
additionalProperties:
type: string
anyOf:
- type: string
nullable: true
- type: integer
- type: number
- type: boolean
- type: object
example:
order_number: ORDER-12345
total_amount: 99.99
custom_object_instance_deleted:
title: Custom Object Instance Deleted
type: object
Expand Down Expand Up @@ -40927,8 +40949,15 @@ components:
example: frodo.baggins@example.com
metadata:
type: object
description: Optional metadata about the event.
additionalProperties: true
description: Optional metadata about the event. Values keep the type they
were sent with.
additionalProperties:
anyOf:
- type: string
- type: integer
- type: number
- type: boolean
- type: object
example:
invite_code: ADDAFRIEND
required:
Expand Down Expand Up @@ -42183,9 +42212,13 @@ components:
items:
properties:
code:
type: string
anyOf:
- type: string
- type: integer
description: A string indicating the kind of error, used to further
qualify the HTTP response code
qualify the HTTP response code. A few request validation errors
send an HTTP status code as an integer here instead, for example
`422`.
example: unauthorized
message:
type: string
Expand Down
52 changes: 42 additions & 10 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 @@ -26853,11 +26853,21 @@ components:
items:
type: integer
avatar:
type: string
format: uri
type: object
nullable: true
description: Image for the associated team or teammate
example: https://picsum.photos/200/300
description: The teammate's avatar image. Left out when the teammate has
neither an uploaded avatar nor a gravatar.
properties:
type:
type: string
description: Value is `avatar`. Returned on the admin endpoints only.
example: avatar
image_url:
type: string
format: uri
nullable: true
description: The URL of the avatar image.
example: https://picsum.photos/200/300
team_priority_level:
"$ref": "#/components/schemas/team_priority_level"
role:
Expand Down Expand Up @@ -34606,9 +34616,21 @@ components:
example: Order
custom_attributes:
type: object
description: The custom attributes you have set on the custom object instance.
description: |-
The custom attributes you have set on the custom object instance.

Each value is returned with the type of the attribute it is set on: a string, integer, number or boolean, or `null` when the attribute is unset. A list attribute returns the label of the selected option. A reference attribute returns an object holding the referenced records, under `contacts` for a contact reference, `conversations` for a conversation reference, or `instances` for a reference to another custom object type.
additionalProperties:
type: string
anyOf:
- type: string
nullable: true
- type: integer
- type: number
- type: boolean
- type: object
example:
order_number: ORDER-12345
total_amount: 99.99
custom_object_instance_deleted:
title: Custom Object Instance Deleted
type: object
Expand Down Expand Up @@ -36384,9 +36406,15 @@ components:
example: frodo.baggins@example.com
metadata:
type: object
description: Optional metadata about the event.
description: Optional metadata about the event. Values keep the type they
were sent with.
additionalProperties:
type: string
anyOf:
- type: string
- type: integer
- type: number
- type: boolean
- type: object
example:
invite_code: ADDAFRIEND
required:
Expand Down Expand Up @@ -37048,9 +37076,13 @@ components:
items:
properties:
code:
type: string
anyOf:
- type: string
- type: integer
description: A string indicating the kind of error, used to further
qualify the HTTP response code
qualify the HTTP response code. A few request validation errors
send an HTTP status code as an integer here instead, for example
`422`.
example: unauthorized
message:
type: string
Expand Down
Loading