Set an admin to away

Request

You can set an Admin as away for the Inbox.

When away_mode_reassign is true, the request can return a 403 if the teammate does not have Inbox access.

Requires the update_admins OAuth scope.

Security

bearerAuth

Path

idintegerrequired

The unique identifier of a given admin

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:Preview

Bodyapplication/json

away_mode_enabledbooleanrequired

Set to true to change the status of the admin to away, or false to set them back to active.

Example:true

away_mode_reassignbooleanrequired

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

Example:false

away_status_reason_idinteger

The unique identifier of the away status reason. Only allowed when away_mode_enabled is true, and the reason can't be archived, unless it is already the admin's current reason. Required if your workspace makes away status reasons mandatory.

Example:12345

curl -i -X PUT \
  'https://api.intercom.io/admins/{id}/away' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: Preview' \
  -d '{
    "away_mode_enabled": true,
    "away_mode_reassign": true,
    "away_status_reason_id": 12345
  }'

Responses

Successful response

Bodyapplication/json

typestring

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

Example:"admin"

idstring

The id representing the admin.

Example:"1295"

namestring

The name of the admin.

Example:"Joe Example"

emailstring

The email of the admin.

Example:"jdoe@example.com"

job_titlestring

The job title of the admin.

Example:"Associate"

away_mode_enabledboolean

Identifies if this admin is currently set in away mode.

Example:false

away_mode_reassignboolean

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

Example:false

away_status_reason_idinteger or null

The unique identifier of the away status reason. Not returned by List all admins.

Example:12345

has_inbox_seatboolean

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

Example:true

team_idsArray of integers

The ids of the teams the admin belongs to. When the workspace has a default team, its id is the last item.

Example:

[
  814865
]

avatarobject or null

The teammate's avatar image. On List all admins it is only included when display_avatar is true. Elsewhere it is left out when the teammate has neither an uploaded avatar nor a gravatar.

team_priority_levelobject or null(Team Priority Level)

Admin priority levels for teams

roleobject or null

The role assigned to this admin. Only present if the admin has a role assigned.

Response

{
  "type": "admin",
  "id": "991267460",
  "name": "Ciaran2 Lee",
  "email": "admin2@email.com",
  "away_mode_enabled": true,
  "away_mode_reassign": true,
  "has_inbox_seat": true,
  "away_status_reason_id": 12345,
  "team_ids": [
    991267903
  ],
  "team_priority_level": {}
}