Skip to content

CreateProfileRequest

Source code in docs_src/capo_customer_profiles/types/create_profile_request.py
class CreateProfileRequest(TypedDict, closed=True):
    domain_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the domain.</p>"""
    account_number: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>An account number that you have assigned to the customer.</p>"""
    additional_information: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to1000.sensitiveString1To1000"
    ]
    """<p>Any additional information relevant to the customer’s profile.</p>"""
    party_type: NotRequired["capo_customer_profiles.types.party_type.PartyType"]
    """<p>The type of profile used to describe the customer.</p>"""
    business_name: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The name of the customer’s business.</p>"""
    first_name: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s first name.</p>"""
    middle_name: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s middle name.</p>"""
    last_name: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s last name.</p>"""
    birth_date: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s birth date. </p>"""
    gender: NotRequired["capo_customer_profiles.types.gender.Gender"]
    """<p>The gender with which the customer identifies. </p>"""
    phone_number: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s phone number, which has not been specified as a mobile, home, or business number. </p>"""
    mobile_phone_number: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s mobile phone number.</p>"""
    home_phone_number: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s home phone number.</p>"""
    business_phone_number: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s business phone number.</p>"""
    email_address: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s email address, which has not been specified as a personal or business address. </p>"""
    personal_email_address: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s personal email address.</p>"""
    business_email_address: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s business email address.</p>"""
    address: NotRequired["capo_customer_profiles.types.address.Address"]
    """<p>A generic address associated with the customer that is not mailing, shipping, or billing.</p>"""
    shipping_address: NotRequired["capo_customer_profiles.types.address.Address"]
    """<p>The customer’s shipping address.</p>"""
    mailing_address: NotRequired["capo_customer_profiles.types.address.Address"]
    """<p>The customer’s mailing address.</p>"""
    billing_address: NotRequired["capo_customer_profiles.types.address.Address"]
    """<p>The customer’s billing address.</p>"""
    attributes: NotRequired["capo_customer_profiles.types.attributes.Attributes"]
    """<p>A key value pair of attributes of a customer profile.</p>"""
    party_type_string: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>An alternative to <code>PartyType</code> which accepts any string as input.</p>"""
    gender_string: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>An alternative to <code>Gender</code> which accepts any string as input.</p>"""
    profile_type: NotRequired["capo_customer_profiles.types.profile_type.ProfileType"]
    """<p>The type of the profile.</p>"""
    engagement_preferences: NotRequired[
        "capo_customer_profiles.types.engagement_preferences.EngagementPreferences"
    ]
    """<p>Object that defines the preferred methods of engagement, per channel.</p>"""

account_number instance-attribute

account_number: NotRequired[sensitiveString1To255]

An account number that you have assigned to the customer.

additional_information instance-attribute

additional_information: NotRequired[sensitiveString1To1000]

Any additional information relevant to the customer’s profile.

address instance-attribute

address: NotRequired[Address]

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

attributes instance-attribute

attributes: NotRequired[Attributes]

A key value pair of attributes of a customer profile.

billing_address instance-attribute

billing_address: NotRequired[Address]

The customer’s billing address.

birth_date instance-attribute

birth_date: NotRequired[sensitiveString1To255]

The customer’s birth date.

business_email_address instance-attribute

business_email_address: NotRequired[sensitiveString1To255]

The customer’s business email address.

business_name instance-attribute

business_name: NotRequired[sensitiveString1To255]

The name of the customer’s business.

business_phone_number instance-attribute

business_phone_number: NotRequired[sensitiveString1To255]

The customer’s business phone number.

domain_name instance-attribute

domain_name: name

The unique name of the domain.

email_address instance-attribute

email_address: NotRequired[sensitiveString1To255]

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

engagement_preferences instance-attribute

engagement_preferences: NotRequired[EngagementPreferences]

Object that defines the preferred methods of engagement, per channel.

first_name instance-attribute

first_name: NotRequired[sensitiveString1To255]

The customer’s first name.

gender instance-attribute

gender: NotRequired[Gender]

The gender with which the customer identifies.

gender_string instance-attribute

gender_string: NotRequired[sensitiveString1To255]

An alternative to Gender which accepts any string as input.

home_phone_number instance-attribute

home_phone_number: NotRequired[sensitiveString1To255]

The customer’s home phone number.

last_name instance-attribute

last_name: NotRequired[sensitiveString1To255]

The customer’s last name.

mailing_address instance-attribute

mailing_address: NotRequired[Address]

The customer’s mailing address.

middle_name instance-attribute

middle_name: NotRequired[sensitiveString1To255]

The customer’s middle name.

mobile_phone_number instance-attribute

mobile_phone_number: NotRequired[sensitiveString1To255]

The customer’s mobile phone number.

party_type instance-attribute

party_type: NotRequired[PartyType]

The type of profile used to describe the customer.

party_type_string instance-attribute

party_type_string: NotRequired[sensitiveString1To255]

An alternative to PartyType which accepts any string as input.

personal_email_address instance-attribute

personal_email_address: NotRequired[sensitiveString1To255]

The customer’s personal email address.

phone_number instance-attribute

phone_number: NotRequired[sensitiveString1To255]

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

profile_type instance-attribute

profile_type: NotRequired[ProfileType]

The type of the profile.

shipping_address instance-attribute

shipping_address: NotRequired[Address]

The customer’s shipping address.