{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "IPAddressRange - Metadata API",
"description": "Represents a range of IP addresses to include in or exclude from the specified feature.",
"file_information": ".IPAddressRange",
"directory_location": "IPAddressRanges",
"fields_columns": [
"type",
"description"
],
"fields": {
"Description": {
"type": "string",
"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",
"description": "Not required. Gives you a way to distinguish ipAddressRange entries among developers in your org."
},
"endIpAddress": {
"type": "string",
"description": "The end of the IP address range. Must be an IPv4 or IPv6 Internet address and equal to or greater than the startIpAddress."
},
"ipAddressFeature": {
"type": "picklist",
"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",
"description": "Whether the specified IP addresses are included or excluded. Possible values are: Exclusion Inclusion"
},
"isProtected": {
"type": "boolean",
"description": "Whether the specified IP address range is protected. The default is false."
},
"masterLabel": {
"type": "string",
"description": "Master label for the IP address range. This internal label doesn’t get translated."
},
"startIpAddress": {
"type": "string",
"description": "The start of the IP address range. Must be an IPv4 or IPv6 Internet address and equal to or smaller than the endIpAddress."
}
},
"wsdl_segment": "```xml\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of an ipAddressName component.",
"code": "\n\n Filter emails from google.com\n 221.224.222.158\n EmailIpFiltering\n Exclusion\n MasterLabelValue\n 221.224.0.158\n false\n"
}
]
}