IPAddressRange

Represents a range of IP addresses to include in or exclude from the specified feature.

Supported SOAP API Calls

create(), delete(), describeLayout(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

Field	Details
Description	Type string Properties Filter, Group, Nillable, Sort Description Not required. The description of the IP address range. For example, the name of the company that owns the IP address range.
DeveloperName	Type string Properties Filter, Group, Sort Description The unique name of the IP address range. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
EndAddress	Type string Properties Filter, Group, Sort Description The end of the IP address range.
FullName	Type string Properties Create, Group, Nillable Description The unique name used as the event delivery identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
IpAddressFeature	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description The feature that uses the range of IP addresses. Possible values are: `EmailIpFiltering` (default) —Filter email engagement activities such as email opens and email clicks.
IpAddressUsageScope	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Whether the specified IP addresses are included or excluded. Possible values are: `Exclusion` `Inclusion`
isProtected	Field Type boolean Description Whether the specified IP address range is protected. The default is `false`.
MasterLabel	Type string Properties Filter, Group, Sort Description Master label for the IP address range. This internal label doesn’t get translated.
Metadata	Type complexvalue Properties Create, Nillable, Update Description The IP address range metadata.
StartAddress	Type string Properties Filter, Group, Sort Description The start of the IP address range.

Usage

Specify a range of IP addresses, which feature the range applies to, and whether the IP addresses are excluded from or included in the feature.

Example

Exclude your coworkers' email opens and clicks from your email engagement reports. Use StartAddress and EndAddress to define the range of IP addresses that your company owns. Set IpAddressFeature to EmailIpFiltering, and set IpAddressUsageScope to Exclusion.