Intercom API (unofficial showcase)
PUT/admins/{admin_id}/away

Set an admin to away

Sets an admin's away status for the Inbox and controls whether new conversation replies are reassigned. Supply away_mode_enabled and away_mode_reassign in the request body; their defaults are true and false, respectively. You can also provide an away status reason identifier.

2 parameters · 3 body fields
admin_idintegerrequired
The unique identifier of the admin whose away status to set.
Intercom-Versionstringoptional
The Intercom API version to use. Supported versions include the listed values; defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Admin away-status settings. Include both away_mode_enabled and away_mode_reassign.

away_mode_enabledbooleanrequired
Set to "true" to change the status of the admin to away.
Default:true
away_mode_reassignbooleanrequired
Set to "true" to assign any new conversation replies to your default inbox.
Default:false
away_status_reason_idintegeroptional
The unique identifier of the away status reason

4 status codes
200Returns the updated admin object, including the away status, reassignment setting, and away status reason identifier.
typestringoptional
String representing the object's type. Always has the value `admin`.
idstringoptional
The id representing the admin.
namestringoptional
The name of the admin.
emailstringoptional
The email of the admin.
job_titlestringoptional
The job title of the admin.
away_mode_enabledbooleanoptional
Identifies if this admin is currently set in away mode.
away_mode_reassignbooleanoptional
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
away_status_reason_idintegeroptional
The unique identifier of the away status reason
has_inbox_seatbooleanoptional
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
team_idsarray<integer>optional
This object represents the avatar associated with the admin.
avatarstringoptional
Image for the associated team or teammate
team_priority_levelobjectoptional
Admin priority levels for teams
roleobjectoptional
The role assigned to this admin. Only present if the admin has a role assigned.
400Returned when the request body is invalid.

2 documented failures

  • parameter_invalid

    Away status reason is deleted

    Example of an invalid away_status_reason_id

  • away_status_reason_mandatory

    Away status reason is mandatory

    Example of a missing away_status_reason_id when away reasons are mandatory

401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the admin does not exist.

One documented failure

  • admin_not_found

    Admin for admin_id not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 400 is returned when the request body is invalid. A 401 is returned when the request is unauthorized, and a 404 is returned when the admin does not exist; the admin_id path parameter must identify an admin. The body must include away_mode_enabled and away_mode_reassign.