Retrieve profiles by address
This method returns one or more profiles that have an exact match on the mailing address field values specified in the request. Passing minimal data in the parameters may result in multiple profiles being returned.
This method can only return up to 50 profiles. If more than 50 matching profiles are found, the API returns a 403-Forbidden. The response will include all active consents, custom fields, groups, tags, and preferences for which you have appropriate permissions.
To increase the likelihood of finding the desired profile, it is recommended to include all available address fields as query parameters. All fields passed in the request must match the corresponding values in the profile for the record to be returned. For example, if you are looking for a profile with the name Audrey Julia Michaels at an unknown address on a street named Jefferson Drive in Roswell, GA, use the request as shown below
GET {clientId}/Profile/Address?address1=Jefferson Drive&city=Roswell&stateProvince=GA&addressType=Home&firstName=Audrey&middleName=Julia&lastName=Michaels&partialAddress1Match=true&partialNameMatch=trueHeader Parameters
Authorization token
Query Parameters
First line of the mailing address in the profile being searched on.
Second line of the mailing address in the profile being searched on.
City, Town, or Village of the mailing address in the profile being searched on.
Province state or district identified in the profile being searched on.
The postal or zip code identified in the address in the profile being searched on.
This is to filter the results on a specific 'Address type' as defined under 'Contact Types' in MyPreferences. As an example this may include home, business, store, or PO Box addresses.
First name of the person whose profile is being searched on.
Middle name of the person whose profile is being searched on.
Last name of the person whose profile is being searched on.
A boolean property when set to true will match on partial address1 field values (Not address 2) For example: When this property is set to true and the user passes in 'Camden', the results will match on '12 Camden Lane' or '134 Camdenisk Way', but not 'Cameron' or '1453 Camdin Rd'. Defaults to false.
A boolean property when set to true will match on partial name fields (firstName, MiddleName, lastName). For example: When this property is set to true and the user passes in a first name of 'Bill' and last name of 'Day', the results will match 'Bill Dayton' or 'Billy Day', but not 'Will Day' or 'Bill David'. Defaults to false.
Boolean flag, when set to true, returns both implied and expressed preferences. Expressed preferences are explicitly stated by individuals, while implied preferences are inherited from the parent Filter when no explicit preference is provided. The Match Type field on a preference record indicates whether a preference is expressed or implied. This distinction is applicable only when the Preference Propagation feature is enabled in your account. Otherwise, all preferences are outpu...
Boolean flag, when set to true returns both active and inactive profiles. If not included, the value will default to false.
Optional parameter that, when set to true, returns consent history. When set to false, it returns only the latest consent information. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id.
Response
Response Attributes
System-generated unique identifier associated with the profile. Read-only.
Defines whether the item is active or inactive.
Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.
Show child attributes
An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.
An identifier used to classify a person based on specific criteria. For example, it can represent their buying stage (prospect, lead, customer), firmographics (industry, company size), or any other criteria.
Specifies whether to retain the contact element consents or deactivate them. To retain the contact element consents, set the value as true. If set to false, the contact element consents will be deactivated. This setting defaults to true, if not specified.
Specifies whether to retain the preferences or deactivate them. To retain the preferences, set the value as true. If set to false, the preferences will be deactivated. This setting defaults to true, if not specified.
Name fields associated with the profile.
Show child attributes
Default Locale for the profile.
Shows 'Complete' if the record is processed, otherwise 'Pending Update.' Read-only.
An optional parameter used when deactivating a profile to specify the reason for deactivation.
A collection of additional unique identifiers that can be associated with a profile. For example, customer identifiers from other applications such as Salesforce, Marketo or Facebook can be stored as AlternateIds.
Show child attributes
A collection of mailing addresses associated with the profile. The address collection can also include any preferences and consents associated with it.
Show child attributes
A collection of email addresses associated with the profile. The email collection can also include any preferences and consents associated with it.
Show child attributes
A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.
Show child attributes
A collection of preferences associated with the user profile. Profile preferences are tied to the user’s profile. These preferences are not associated with any contact element on the profile.
Show child attributes
A collection of consents associated with the profile.
Show child attributes
A collection of custom fields associated with the profile.
Show child attributes
A collection of Groups associated with the profile.
Show child attributes
A collection of Tags associated with the profile.
Show child attributes
What made this section unhelpful for you?
Response
What made this section unhelpful for you?