Update IP allowlist settings

REST API Reference

Request

Update the IP allowlist configuration for the workspace.

Both enabled and ip_allowlist are optional. A field you omit is left unchanged, and a request with neither returns the current settings without changing anything. Sending null for a field is the same as omitting it.

Every non-blank ip_allowlist entry must be an IPv4 address or an IPv4 range in CIDR notation. Blank entries are ignored and surrounding whitespace is trimmed. Any other entry, including an IPv6 address, returns a 422 parameter_invalid error.

When the update leaves the allowlist enabled with at least one entry, the request must come from an IPv4 address that is on the list. A request from an IPv6 address can never match an IPv4 allowlist, so it returns the lockout 422 below.

Requires the manage_ip_allowlist OAuth scope.

Lockout Protection

The API will reject updates that would lock out the caller's IP address. Ensure your current IP is included in the allowlist when enabling the feature.

Security

bearerAuth

Intercom-Versionstring(intercom_version)

Intercom API version.
If you omit the header, the API uses the version set in your app package, and 1.0 if none is set.

Enum:"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example:2.17

Bodyapplication/json

typestring

String representing the object's type. Always has the value ip_allowlist.

Example:"ip_allowlist"

enabledboolean

Whether the IP allowlist is enabled for the workspace.

Example:true

ip_allowlistArray of strings

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)

Example:

[
  "192.168.1.0/24",
  "10.0.0.1"
]

curl -i -X PUT \
  https://api.intercom.io/ip_allowlist \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.17' \
  -d '{
    "enabled": true,
    "ip_allowlist": [
      "192.168.1.0/24",
      "10.0.0.1"
    ]
  }'

Responses

Successful response