CustomerProfiles / Client / update_profile

update_profile#

CustomerProfiles.Client.update_profile(**kwargs)#

Updates the properties of a profile. The ProfileId is required for updating a customer profile.

When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.

See also: AWS API Documentation

Request Syntax

response = client.update_profile(
    DomainName='string',
    ProfileId='string',
    AdditionalInformation='string',
    AccountNumber='string',
    PartyType='INDIVIDUAL'|'BUSINESS'|'OTHER',
    BusinessName='string',
    FirstName='string',
    MiddleName='string',
    LastName='string',
    BirthDate='string',
    Gender='MALE'|'FEMALE'|'UNSPECIFIED',
    PhoneNumber='string',
    MobilePhoneNumber='string',
    HomePhoneNumber='string',
    BusinessPhoneNumber='string',
    EmailAddress='string',
    PersonalEmailAddress='string',
    BusinessEmailAddress='string',
    Address={
        'Address1': 'string',
        'Address2': 'string',
        'Address3': 'string',
        'Address4': 'string',
        'City': 'string',
        'County': 'string',
        'State': 'string',
        'Province': 'string',
        'Country': 'string',
        'PostalCode': 'string'
    },
    ShippingAddress={
        'Address1': 'string',
        'Address2': 'string',
        'Address3': 'string',
        'Address4': 'string',
        'City': 'string',
        'County': 'string',
        'State': 'string',
        'Province': 'string',
        'Country': 'string',
        'PostalCode': 'string'
    },
    MailingAddress={
        'Address1': 'string',
        'Address2': 'string',
        'Address3': 'string',
        'Address4': 'string',
        'City': 'string',
        'County': 'string',
        'State': 'string',
        'Province': 'string',
        'Country': 'string',
        'PostalCode': 'string'
    },
    BillingAddress={
        'Address1': 'string',
        'Address2': 'string',
        'Address3': 'string',
        'Address4': 'string',
        'City': 'string',
        'County': 'string',
        'State': 'string',
        'Province': 'string',
        'Country': 'string',
        'PostalCode': 'string'
    },
    Attributes={
        'string': 'string'
    },
    PartyTypeString='string',
    GenderString='string'
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The unique name of the domain.

  • ProfileId (string) –

    [REQUIRED]

    The unique identifier of a customer profile.

  • AdditionalInformation (string) – Any additional information relevant to the customer’s profile.

  • AccountNumber (string) – An account number that you have given to the customer.

  • PartyType (string) – The type of profile used to describe the customer.

  • BusinessName (string) – The name of the customer’s business.

  • FirstName (string) – The customer’s first name.

  • MiddleName (string) – The customer’s middle name.

  • LastName (string) – The customer’s last name.

  • BirthDate (string) – The customer’s birth date.

  • Gender (string) – The gender with which the customer identifies.

  • PhoneNumber (string) – The customer’s phone number, which has not been specified as a mobile, home, or business number.

  • MobilePhoneNumber (string) – The customer’s mobile phone number.

  • HomePhoneNumber (string) – The customer’s home phone number.

  • BusinessPhoneNumber (string) – The customer’s business phone number.

  • EmailAddress (string) – The customer’s email address, which has not been specified as a personal or business address.

  • PersonalEmailAddress (string) – The customer’s personal email address.

  • BusinessEmailAddress (string) – The customer’s business email address.

  • Address (dict) –

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

    • Address1 (string) –

      The first line of a customer address.

    • Address2 (string) –

      The second line of a customer address.

    • Address3 (string) –

      The third line of a customer address.

    • Address4 (string) –

      The fourth line of a customer address.

    • City (string) –

      The city in which a customer lives.

    • County (string) –

      The county in which a customer lives.

    • State (string) –

      The state in which a customer lives.

    • Province (string) –

      The province in which a customer lives.

    • Country (string) –

      The country in which a customer lives.

    • PostalCode (string) –

      The postal code of a customer address.

  • ShippingAddress (dict) –

    The customer’s shipping address.

    • Address1 (string) –

      The first line of a customer address.

    • Address2 (string) –

      The second line of a customer address.

    • Address3 (string) –

      The third line of a customer address.

    • Address4 (string) –

      The fourth line of a customer address.

    • City (string) –

      The city in which a customer lives.

    • County (string) –

      The county in which a customer lives.

    • State (string) –

      The state in which a customer lives.

    • Province (string) –

      The province in which a customer lives.

    • Country (string) –

      The country in which a customer lives.

    • PostalCode (string) –

      The postal code of a customer address.

  • MailingAddress (dict) –

    The customer’s mailing address.

    • Address1 (string) –

      The first line of a customer address.

    • Address2 (string) –

      The second line of a customer address.

    • Address3 (string) –

      The third line of a customer address.

    • Address4 (string) –

      The fourth line of a customer address.

    • City (string) –

      The city in which a customer lives.

    • County (string) –

      The county in which a customer lives.

    • State (string) –

      The state in which a customer lives.

    • Province (string) –

      The province in which a customer lives.

    • Country (string) –

      The country in which a customer lives.

    • PostalCode (string) –

      The postal code of a customer address.

  • BillingAddress (dict) –

    The customer’s billing address.

    • Address1 (string) –

      The first line of a customer address.

    • Address2 (string) –

      The second line of a customer address.

    • Address3 (string) –

      The third line of a customer address.

    • Address4 (string) –

      The fourth line of a customer address.

    • City (string) –

      The city in which a customer lives.

    • County (string) –

      The county in which a customer lives.

    • State (string) –

      The state in which a customer lives.

    • Province (string) –

      The province in which a customer lives.

    • Country (string) –

      The country in which a customer lives.

    • PostalCode (string) –

      The postal code of a customer address.

  • Attributes (dict) –

    A key value pair of attributes of a customer profile.

    • (string) –

      • (string) –

  • PartyTypeString (string) – An alternative to PartyType which accepts any string as input.

  • GenderString (string) – An alternative to Gender which accepts any string as input.

Return type:

dict

Returns:

Response Syntax

{
    'ProfileId': 'string'
}

Response Structure

  • (dict) –

    • ProfileId (string) –

      The unique identifier of a customer profile.

Exceptions