IPAddressRange

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

Version 

Introduced in API version 52.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

Description 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Introduced: API version 52.0

• 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

• Required: No

• 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

• Required: No

• Properties: Filter, Group, Sort

• Introduced: API version 52.0

• Description: The end of the IP address range.

FullName 

• Type: string

• Required: No

• Properties: Create, Group, Nillable

• Introduced: API version 52.0

• 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

• Required: No

• Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

• Introduced: API version 52.0

• Description: The feature that uses the range of IP addresses.

• Possible values:

  • EmailIpFiltering — Email IP Filtering (default) — Filter email engagement activities such as email opens and email clicks.

• Default value: EmailIpFiltering

IpAddressUsageScope 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Restricted picklist, Sort

• Introduced: API version 52.0

• Description: Whether the specified IP addresses are included or excluded.

• Possible values:

  • Exclusion — Exclusion (default)

  • Inclusion — Inclusion

• Default value: Exclusion

Language 

• Type: picklist

• Required: No

• Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

• Description: The language of the IP Address Range.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

MasterLabel 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Description: Master label for the IP address range. This internal label doesn’t get translated.

Metadata 

• Type: complexvalue

• Required: No

• Properties: Create, Nillable, Update

• Introduced: API version 52.0

• Description: The IP address range metadata.

StartAddress 

• Type: string

• Required: No

• Properties: Filter, Group, Sort

• Introduced: API version 52.0

• 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.

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.