Sign in

v51

latestOpenAPI 3.0.1MITraw.githubusercontent.com2026-08-01150230854.3 KB
Admins

Set an admin to away

You can set an Admin as away for the Inbox.

put/admins/{admin_id}/away

Path parameters

admin_idinteger required

The unique identifier of a given admin

Headers

Intercom-Version'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' | '2.11' | '2.12' | '2.13' | '2.14'

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

Example:2.14

Request body

away_mode_enabledboolean required

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

away_mode_reassignboolean required

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

away_status_reason_idinteger

The unique identifier of the away status reason

Example request

{
  "away_mode_enabled": true,
  "away_status_reason_id": 12345
}

Response

Successful response

typestring

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

idstring

The id representing the admin.

namestring

The name of the admin.

emailstring

The email of the admin.

job_titlestring

The job title of the admin.

away_mode_enabledboolean

Identifies if this admin is currently set in away mode.

away_mode_reassignboolean

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

away_status_reason_idinteger nullable

The unique identifier of the away status reason

has_inbox_seatboolean

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

team_idsinteger[]

This object represents the avatar associated with the admin.

avatarstring uri nullable

Image for the associated team or teammate

Example response

{
  "type": "admin",
  "id": "1295",
  "name": "Joe Example",
  "email": "jdoe@example.com",
  "job_title": "Associate",
  "away_status_reason_id": 12345,
  "has_inbox_seat": true,
  "team_ids": [
    814865
  ],
  "avatar": "https://picsum.photos/200/300",
  "team_priority_level": {
    "primary_team_ids": [
      814865
    ],
    "secondary_team_ids": [
      493881
    ]
  }
}