DocsBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreForumBlogYour Apps

Set an admin to away

You can set an Admin as away for the Inbox.

Request Body Parameters

Attribute

Type

Description

id

string

The id of the admin you want to set away mode or re-assign conversations.

away_mode_enabled

boolean

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

away_mode_reassign

boolean

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

Example Request & Response

$ curl https://api.intercom.io/admins/814860/away \
-X PUT \
-H 'Authorization: Bearer <Your access token>' \
-H 'Accept: application/json'  \
-H 'Content-Type: application/json' -d

{
  "away_mode_enabled": true,
  "away_mode_reassign": false

}
HTTP/1.1 200 Ok

{
    "type": "admin",
    "id": "814860",
    "name": "Hoban Washburne",
    "email": "[email protected]",
    "away_mode_enabled": true,
    "away_mode_reassign": false,
    "team_ids": [
        814865
    ]
}
Example Errors

{
    "type": "error.list",
    "request_id": "0002miv9og586ig3aln0",
    "errors": [
        {
            "code": "action_forbidden",
            "message": "This admin does not have Inbox access permissions"
        }
    ]
}

Response

This will return an Admin model of the admin set away.