89
89
away_mode_enabled: true
90
90
away_mode_reassign: true
91
91
has_inbox_seat: true
92
+ away_status_reason_id: '12345'
92
93
team_ids: []
93
94
schema:
94
95
"$ref": "#/components/schemas/admin"
@@ -106,6 +107,25 @@ paths:
106
107
message: Admin for admin_id not found
107
108
schema:
108
109
"$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"
109
129
'401':
110
130
description: Unauthorized
111
131
content:
@@ -141,12 +161,17 @@ paths:
141
161
to your default inbox.
142
162
example: false
143
163
default: false
164
+ away_status_reason_id:
165
+ type: integer
166
+ description: The unique identifier of the away status reason
167
+ example: 12345
144
168
examples:
145
169
successful_response:
146
170
summary: Successful response
147
171
value:
148
172
away_mode_enabled: true
149
173
away_mode_reassign: true
174
+ away_status_reason_id: 12345
150
175
admin_not_found:
151
176
summary: Admin not found
152
177
value:
@@ -327,6 +352,7 @@ paths:
327
352
away_mode_enabled: false
328
353
away_mode_reassign: false
329
354
has_inbox_seat: true
355
+ away_status_reason_id: null
330
356
team_ids: []
331
357
schema:
332
358
"$ref": "#/components/schemas/admin"
@@ -13002,6 +13028,11 @@ components:
13002
13028
description: Identifies if this admin is set to automatically reassign new
13003
13029
conversations to the apps default inbox.
13004
13030
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
13005
13036
has_inbox_seat:
13006
13037
type: boolean
13007
13038
description: Identifies if this admin has a paid inbox seat to restrict/allow
0 commit comments