Profile

The standard profile of a customer.

AccountNumber

An account number that you have assigned to the customer.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

AdditionalInformation

Any additional information relevant to the customer’s profile.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

Address

A generic address associated with the customer that is not mailing, shipping, or billing.

Type: Address object

Required: No

Attributes

A key value pair of attributes of a customer profile.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 255.

Value Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

BillingAddress

The customer’s billing address.

Type: Address object

Required: No

BirthDate

The customer’s birth date.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

BusinessEmailAddress

The customer’s business email address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

BusinessName

The name of the customer’s business.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

BusinessPhoneNumber

The customer’s home phone number.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

EmailAddress

The customer’s email address, which has not been specified as a personal or business address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

EngagementPreferences

The customer or account’s engagement preferences.

Type: EngagementPreferences object

Required: No

FirstName

The customer’s first name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

FoundByItems

A list of items used to find a profile returned in a SearchProfiles response. An item is a key-value(s) pair that matches an attribute in the profile.

If the optional AdditionalSearchKeys parameter was included in the SearchProfiles request, the FoundByItems list should be interpreted based on the LogicalOperator used in the request:

AND - The profile included in the response matched all of the search keys specified in the request. The FoundByItems will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of AND search logic).
OR - The profile included in the response matched at least one of the search keys specified in the request. The FoundByItems will include each of the key-value(s) pairs that the profile was found by.

The OR relationship is the default behavior if the LogicalOperator parameter is not included in the SearchProfiles request.

Type: Array of FoundByKeyValue objects

Array Members: Minimum number of 1 item. Maximum number of 5 items.

Required: No

Gender

This member has been deprecated.

The gender with which the customer identifies.

Type: String

Valid Values: MALE | FEMALE | UNSPECIFIED

Required: No

GenderString

An alternative to Gender which accepts any string as input.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

HomePhoneNumber

The customer’s home phone number.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

LastName

The customer’s last name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

MailingAddress

The customer’s mailing address.

Type: Address object

Required: No

MiddleName

The customer’s middle name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

MobilePhoneNumber

The customer’s mobile phone number.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

PartyType

This member has been deprecated.

The type of profile used to describe the customer.

Type: String

Valid Values: INDIVIDUAL | BUSINESS | OTHER

Required: No

PartyTypeString

An alternative to PartyType which accepts any string as input.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

PersonalEmailAddress

The customer’s personal email address.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

PhoneNumber

The customer's phone number, which has not been specified as a mobile, home, or business number.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

ProfileId

The unique identifier of a customer profile.

Type: String

Pattern: [a-f0-9]{32}

Required: No

ProfileType

The type of the profile.

Type: String

Valid Values: ACCOUNT_PROFILE | PROFILE

Required: No

ShippingAddress

The customer’s shipping address.

Type: Address object

Required: No

Profile

Contents

See Also