> ## 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: Update Ip Allowlist

> Turn on or change the IP allowlist of an Intercom workspace. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Turn on or change the IP allowlist of an Intercom workspace.

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

## 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_update_ip_allowlist',
  {
    "type": "example",
    "enabled": true,
    "ip_allowlist": [
      "example"
    ]
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_update_ip_allowlist --input '{
  "type": "example",
  "enabled": true,
  "ip_allowlist": [
    "example"
  ]
}' --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",
    "enabled": true,
    "ip_allowlist": [
      "example"
    ]
  }
}
```

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

## Input reference

IP allowlist settings for the workspace.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.type` | `string` | No | — | String representing the object's type. Always has the value `ip_allowlist`. |
| `payload.enabled` | `boolean` | No | — | Whether the IP allowlist is enabled for the workspace. |
| `payload.ip_allowlist` | `array` | No | — | List of allowed IP addresses and/or IP ranges in CIDR notation. Examples: - Single IP: `192.168.0.1` - IP range: `192.168.0.1/24` (allows 192.168.0.0 - 192.168.0.255) |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "IP allowlist settings for the workspace.",
    "properties": {
      "type": {
        "type": "string",
        "description": "String representing the object's type. Always has the value `ip_allowlist`."
      },
      "enabled": {
        "type": "boolean",
        "description": "Whether the IP allowlist is enabled for the workspace."
      },
      "ip_allowlist": {
        "type": "array",
        "description": "List of allowed IP addresses and/or IP ranges in CIDR notation. Examples: - Single IP: `192.168.0.1` - IP range: `192.168.0.1/24` (allows 192.168.0.0 - 192.168.0.255)",
        "items": {
          "type": "string"
        }
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | IP allowlist settings for the workspace. |
| `result.data.type` | `string` | No | — | String representing the object's type. Always has the value `ip_allowlist`. |
| `result.data.enabled` | `boolean` | No | — | Whether the IP allowlist is enabled for the workspace. |
| `result.data.ip_allowlist` | `array` | No | — | List of allowed IP addresses and/or IP ranges in CIDR notation. Examples: - Single IP: `192.168.0.1` - IP range: `192.168.0.1/24` (allows 192.168.0.0 - 192.168.0.255) |
| `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",
        "description": "IP allowlist settings for the workspace.",
        "properties": {
          "type": {
            "type": "string",
            "description": "String representing the object's type. Always has the value `ip_allowlist`."
          },
          "enabled": {
            "type": "boolean",
            "description": "Whether the IP allowlist is enabled for the workspace."
          },
          "ip_allowlist": {
            "type": "array",
            "description": "List of allowed IP addresses and/or IP ranges in CIDR notation. Examples: - Single IP: `192.168.0.1` - IP range: `192.168.0.1/24` (allows 192.168.0.0 - 192.168.0.255)",
            "items": {
              "type": "string"
            }
          }
        },
        "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.