Intercom API (unofficial showcase)
PUT/ip_allowlist

Update IP allowlist settings

Updates the workspace's IP allowlist configuration. Supply enabled to control whether the allowlist is active and ip_allowlist to set allowed IP addresses or CIDR ranges. Include the caller's current IP address before enabling the allowlist to avoid locking out the caller.

1 parameter · 3 body fields
Intercom-Versionstringoptional
Selects the API version. Defaults to `2.17` when omitted; supported versions include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

IP allowlist configuration for the workspace; send the properties you want to set.

typestringoptional
String representing the object's type. Always has the value `ip_allowlist`.
enabledbooleanoptional
Whether the IP allowlist is enabled for the workspace.
ip_allowlistarray<string>optional
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)

3 status codes
200Returns the updated IP allowlist configuration, including whether it is enabled and the allowed IP addresses or CIDR ranges.
typestringoptional
String representing the object's type. Always has the value `ip_allowlist`.
enabledbooleanoptional
Whether the IP allowlist is enabled for the workspace.
ip_allowlistarray<string>optional
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)
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
422Returned when the configuration is invalid or the update would lock out the caller's IP address.

One documented failure

  • parameter_invalid

    Your IP (1.2.3.4) is not on the allowlist. Saving would lock you out of this workspace.

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. A 422 is returned when the update fails validation or would lock out the caller's IP address. Include the current IP in ip_allowlist when enabling the allowlist.