> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: Set Away Admin

> Set an Intercom admin as away or back, optionally reassigning their conversations. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Set an Intercom admin as away or back, optionally reassigning their conversations.

> [!NOTE]
>
> Tool ID: `intercom_set_away_admin`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_set_away_admin',
  {
    "admin_id": 123,
    "away_mode_enabled": true,
    "away_mode_reassign": false
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_set_away_admin --input '{
  "admin_id": 123,
  "away_mode_enabled": true,
  "away_mode_reassign": false
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "type": "example",
    "id": "id_123",
    "name": "Example"
  }
}
```

Use `deepline describe intercom_set_away_admin --json` for the latest machine-readable contract.

## Input reference

You can set an Admin as away for the Inbox.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.admin_id` | `integer` | Yes | — | The unique identifier of a given admin |
| `payload.away_mode_enabled` | `boolean` | Yes | `true` | Set to "true" to change the status of the admin to away. |
| `payload.away_mode_reassign` | `boolean` | Yes | `false` | Set to "true" to assign any new conversation replies to your default inbox. |
| `payload.away_status_reason_id` | `integer` | No | — | The unique identifier of the away status reason |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can set an Admin as away for the Inbox.",
    "properties": {
      "admin_id": {
        "type": "integer",
        "description": "The unique identifier of a given admin"
      },
      "away_mode_enabled": {
        "type": "boolean",
        "description": "Set to \"true\" to change the status of the admin to away.",
        "default": true
      },
      "away_mode_reassign": {
        "type": "boolean",
        "description": "Set to \"true\" to assign any new conversation replies to your default inbox.",
        "default": false
      },
      "away_status_reason_id": {
        "type": "integer",
        "description": "The unique identifier of the away status reason"
      }
    },
    "required": [
      "admin_id",
      "away_mode_enabled",
      "away_mode_reassign"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Admins are teammate accounts that have access to a workspace. |
| `result.data.type` | `string` | No | — | String representing the object's type. Always has the value `admin`. |
| `result.data.id` | `string` | No | — | The id representing the admin. |
| `result.data.name` | `string` | No | — | The name of the admin. |
| `result.data.email` | `string` | No | — | The email of the admin. |
| `result.data.job_title` | `string` | No | — | The job title of the admin. |
| `result.data.away_mode_enabled` | `boolean` | No | — | Identifies if this admin is currently set in away mode. |
| `result.data.away_mode_reassign` | `boolean` | No | — | Identifies if this admin is set to automatically reassign new conversations to the apps default inbox. |
| `result.data.away_status_reason_id` | `integer \| null` | No | — | The unique identifier of the away status reason |
| `result.data.has_inbox_seat` | `boolean` | No | — | Identifies if this admin has a paid inbox seat to restrict/allow features that require them. |
| `result.data.team_ids` | `array` | No | — | This object represents the avatar associated with the admin. |
| `result.data.avatar` | `string \| null` | No | — | Image for the associated team or teammate Format: `uri`. |
| `result.data.team_priority_level` | `object \| null` | No | — | Admin priority levels for teams |
| `result.data.team_priority_level.primary_team_ids` | `array \| null` | No | — | The primary team ids for the team |
| `result.data.team_priority_level.secondary_team_ids` | `array \| null` | No | — | The secondary team ids for the team |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "Admins are teammate accounts that have access to a workspace.",
        "properties": {
          "type": {
            "type": "string",
            "description": "String representing the object's type. Always has the value `admin`."
          },
          "id": {
            "type": "string",
            "description": "The id representing the admin."
          },
          "name": {
            "type": "string",
            "description": "The name of the admin."
          },
          "email": {
            "type": "string",
            "description": "The email of the admin."
          },
          "job_title": {
            "type": "string",
            "description": "The job title of the admin."
          },
          "away_mode_enabled": {
            "type": "boolean",
            "description": "Identifies if this admin is currently set in away mode."
          },
          "away_mode_reassign": {
            "type": "boolean",
            "description": "Identifies if this admin is set to automatically reassign new conversations to the apps default inbox."
          },
          "away_status_reason_id": {
            "type": [
              "integer",
              "null"
            ],
            "description": "The unique identifier of the away status reason"
          },
          "has_inbox_seat": {
            "type": "boolean",
            "description": "Identifies if this admin has a paid inbox seat to restrict/allow features that require them."
          },
          "team_ids": {
            "type": "array",
            "description": "This object represents the avatar associated with the admin.",
            "items": {
              "type": "integer"
            }
          },
          "avatar": {
            "type": [
              "string",
              "null"
            ],
            "description": "Image for the associated team or teammate",
            "format": "uri"
          },
          "team_priority_level": {
            "type": [
              "object",
              "null"
            ],
            "description": "Admin priority levels for teams",
            "properties": {
              "primary_team_ids": {
                "type": [
                  "array",
                  "null"
                ],
                "description": "The primary team ids for the team",
                "items": {
                  "type": "integer"
                }
              },
              "secondary_team_ids": {
                "type": [
                  "array",
                  "null"
                ],
                "description": "The secondary team ids for the team",
                "items": {
                  "type": "integer"
                }
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.