Skip to content

Commit d2b216b

Browse files
docs: Add role property to admin and admin_with_app schemas (#370)
Add role object (type, id, name) to the admin API response schemas in the Unstable OpenAPI spec. Corresponds to intercom/intercom#470909. Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 1820ff5 commit d2b216b

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15620,6 +15620,25 @@ components:
1562015620
example: https://picsum.photos/200/300
1562115621
team_priority_level:
1562215622
"$ref": "#/components/schemas/team_priority_level"
15623+
role:
15624+
type: object
15625+
nullable: true
15626+
description: The role assigned to this admin. Only present if the admin has
15627+
a role assigned.
15628+
properties:
15629+
type:
15630+
type: string
15631+
description: String representing the object's type. Always has the value
15632+
`role`.
15633+
example: role
15634+
id:
15635+
type: string
15636+
description: The id of the role.
15637+
example: '1'
15638+
name:
15639+
type: string
15640+
description: The name of the role.
15641+
example: Support Agent
1562315642
admin_list:
1562415643
title: Admins
1562515644
type: object
@@ -15848,6 +15867,25 @@ components:
1584815867
description: Identifies if this admin's email is verified.
1584915868
nullable: true
1585015869
example: true
15870+
role:
15871+
type: object
15872+
nullable: true
15873+
description: The role assigned to this admin. Only present if the admin has
15874+
a role assigned.
15875+
properties:
15876+
type:
15877+
type: string
15878+
description: String representing the object's type. Always has the value
15879+
`role`.
15880+
example: role
15881+
id:
15882+
type: string
15883+
description: The id of the role.
15884+
example: '1'
15885+
name:
15886+
type: string
15887+
description: The name of the role.
15888+
example: Support Agent
1585115889
app:
1585215890
"$ref": "#/components/schemas/app"
1585315891
nullable: true

0 commit comments

Comments
 (0)