Skip to content

Commit 9535b18

Browse files
authored
add away_status_reason_id to admins away endpoint (#249)
* add away_status_reason_id to admins away endpoint * expose away_status_reason_id correctly
1 parent eb345e7 commit 9535b18

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ paths:
8989
away_mode_enabled: true
9090
away_mode_reassign: true
9191
has_inbox_seat: true
92+
away_status_reason_id: '12345'
9293
team_ids: []
9394
schema:
9495
"$ref": "#/components/schemas/admin"
@@ -106,6 +107,25 @@ paths:
106107
message: Admin for admin_id not found
107108
schema:
108109
"$ref": "#/components/schemas/error"
110+
'400':
111+
description: Bad Request
112+
content:
113+
application/json:
114+
examples:
115+
parameter_invalid:
116+
summary: "Example of an invalid away_status_reason_id"
117+
value:
118+
type: error.list
119+
errors:
120+
- code: parameter_invalid
121+
message: "Away status reason is deleted"
122+
away_status_reason_mandatory:
123+
summary: "Example of a missing away_status_reason_id when away reasons are mandatory"
124+
value:
125+
type: error.list
126+
errors:
127+
- code: away_status_reason_mandatory
128+
message: "Away status reason is mandatory"
109129
'401':
110130
description: Unauthorized
111131
content:
@@ -141,12 +161,17 @@ paths:
141161
to your default inbox.
142162
example: false
143163
default: false
164+
away_status_reason_id:
165+
type: integer
166+
description: The unique identifier of the away status reason
167+
example: 12345
144168
examples:
145169
successful_response:
146170
summary: Successful response
147171
value:
148172
away_mode_enabled: true
149173
away_mode_reassign: true
174+
away_status_reason_id: 12345
150175
admin_not_found:
151176
summary: Admin not found
152177
value:
@@ -327,6 +352,7 @@ paths:
327352
away_mode_enabled: false
328353
away_mode_reassign: false
329354
has_inbox_seat: true
355+
away_status_reason_id: null
330356
team_ids: []
331357
schema:
332358
"$ref": "#/components/schemas/admin"
@@ -13002,6 +13028,11 @@ components:
1300213028
description: Identifies if this admin is set to automatically reassign new
1300313029
conversations to the apps default inbox.
1300413030
example: false
13031+
away_status_reason_id:
13032+
type: integer
13033+
nullable: true
13034+
description: The unique identifier of the away status reason
13035+
example: 12345
1300513036
has_inbox_seat:
1300613037
type: boolean
1300713038
description: Identifies if this admin has a paid inbox seat to restrict/allow

0 commit comments

Comments
 (0)