younifyd
Menu

Set Away Admin

Set an admin to away

PUT/admins/{admin_id}/away

Use it in a workflow

  1. Add a step and choose the Intercom connector.
  2. Pick the Set Away Admin action (under Admins).
  3. Fill in the fields below, then reference the result from later steps as {{setAwayAdmin.response.data}}.

Request

Path parameters

admin_idintegerrequired

The unique identifier of a given admin

Headers

Intercom-Versionstring

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

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Request body

Enter the body as JSON in the step's Body field.

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_idinteger

The unique identifier of the away status reason

json
{
  "away_mode_enabled": true,
  "away_mode_reassign": false,
  "away_status_reason_id": 12345
}

Response

Returns 200 with an object. Read it in later steps with {{setAwayAdmin.response.data.<field>}}.

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

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_idsarray<integer>

This object represents the avatar associated with the admin.

avatarstring (uri)

Image for the associated team or teammate

team_priority_levelobject

Admin priority levels for teams

primary_team_idsarray<integer>

The primary team ids for the team

secondary_team_idsarray<integer>

The secondary team ids for the team

roleobject

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

typestring

String representing the object's type. Always has the value `role`.

idstring

The id of the role.

namestring

The name of the role.

json
{
  "type": "admin",
  "id": "1295",
  "name": "Joe Example",
  "email": "jdoe@example.com",
  "job_title": "Associate",
  "away_mode_enabled": false,
  "away_mode_reassign": false,
  "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
    ]
  }
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.