Skip to content

add away_status_reason_id to admins away endpoint #249

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.

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

Merged
merged 2 commits into from
Apr 16, 2025
Merged
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions descriptions/0/api.intercom.io.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ paths:
away_mode_enabled: true
away_mode_reassign: true
has_inbox_seat: true
away_status_reason_id: '12345'
team_ids: []
schema:
"$ref": "#/components/schemas/admin"
Expand All @@ -106,6 +107,25 @@ paths:
message: Admin for admin_id not found
schema:
"$ref": "#/components/schemas/error"
'400':
description: Bad Request
content:
application/json:
examples:
parameter_invalid:
summary: "Example of an invalid away_status_reason_id"
value:
type: error.list
errors:
- code: parameter_invalid
message: "Away status reason is deleted"
away_status_reason_mandatory:
summary: "Example of a missing away_status_reason_id when away reasons are mandatory"
value:
type: error.list
errors:
- code: away_status_reason_mandatory
message: "Away status reason is mandatory"
'401':
description: Unauthorized
content:
Expand Down Expand Up @@ -141,12 +161,17 @@ paths:
to your default inbox.
example: false
default: false
away_status_reason_id:
type: integer
description: The unique identifier of the away status reason
example: 12345
examples:
successful_response:
summary: Successful response
value:
away_mode_enabled: true
away_mode_reassign: true
away_status_reason_id: 12345
admin_not_found:
summary: Admin not found
value:
Expand Down Expand Up @@ -327,6 +352,7 @@ paths:
away_mode_enabled: false
away_mode_reassign: false
has_inbox_seat: true
away_status_reason_id: null
team_ids: []
schema:
"$ref": "#/components/schemas/admin"
Expand Down Expand Up @@ -13002,6 +13028,11 @@ components:
description: Identifies if this admin is set to automatically reassign new
conversations to the apps default inbox.
example: false
away_status_reason_id:
type: integer
nullable: true
description: The unique identifier of the away status reason
example: 12345
has_inbox_seat:
type: boolean
description: Identifies if this admin has a paid inbox seat to restrict/allow
Expand Down