Home
/
REST API Reference
/
Admins
/
Set an admin to away

Set an admin to away

You can set an Admin as away for the Inbox.

SecurityHTTP: bearerAuth
Request
path Parameters
id
required
integer

The unique identifier of a given admin

header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "Unstable"
Example: 2.10
Request Body schema: application/json
away_mode_enabled
required
boolean
Default: true

Set to "true" to change the status of the admin to away.

away_mode_reassign
required
boolean
Default: false

Set to "true" to assign any new conversation replies to your default inbox.

put
/admins/{id}/away
Request samples
application/json
{
"away_mode_enabled": true,
"away_mode_reassign": true
}
Responses

200

Successful response

Response Schema: application/json
type
string

String representing the object's type. Always has the value admin.

id
string

The id representing the admin.

name
string

The name of the admin.

email
string

The email of the admin.

job_title
string

The job title of the admin.

away_mode_enabled
boolean

Identifies if this admin is currently set in away mode.

away_mode_reassign
boolean

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

has_inbox_seat
boolean

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

team_ids
Array of integers

This object represents the avatar associated with the admin.

avatar
string or null <uri>

Image for the associated team or teammate

object or null (Team Priority Level)

Admin priority levels for teams

401

Unauthorized

404

Admin not found

Response samples
application/json
{
"type": "admin",
"id": "991282283",
"name": "Ciaran2 Lee",
"email": "admin2@email.com",
"away_mode_enabled": true,
"away_mode_reassign": true,
"has_inbox_seat": true,
"team_ids": [ ]
}