GetCustomerProfile - Amazon Connect

GetCustomerProfile

Retrieve a customer profile based on email or phone number. Customer Profiles must be enabled for your Amazon Connect instance.

See SearchProfiles in the Amazon Connect Customer Profiles API Reference.

Parameter object

A search key (phone number or email) must be present.

{ "ProfileRequestData": { "PhoneNumber": Phone number to search for profiles with. "EmailAddress": Email address to search for profiles with. }, "ProfileResponseData": { All of these fields are optional. Profile ID, if a single profile is found, is always persisted under the Customer -> ProfileID attribute + $.Customer.ProfileId "FirstName", "LastName", "PhoneNumber", "EmailAddress", "AccountNumber", "Address1", "Address2", "Address3", "Address4", "City", "Country", "County", "PostalCode", "Province", "State" } }

Results and conditions

None. Conditions are not supported. If an error does not occur, the response's attributes are available dynamically under the $.Customer path based on the attributes included in ProfileResponseData.

Errors

  • MultipleFoundError - if multiple profiles were found for the associated profile search key.

  • NoneFoundError - if no profiles were found for the associated profile search key.

  • NoMatchingError - if no other Error matches.

Corresponding block in the UI

Customer profiles