Update Customer Details

Event Key

ootb_user_details_update

This event should be sent when a user updates their profile or registration details (e.g., email, preferences, personal info).

Event Key	Event Name	Type
`ootb_user_details_update`	Update Customer Details	Simple event

Event Structure

The mandatory properties (tenant, timestamp, event, and customer) are required for all events and documented in detail on the Mandatory Properties page. Below is the JSON structure for the context-specific properties of the Update Customer Details event:

{
  "context": {
    "ootb_email": "[email protected]",
    "ootb_mobile_number": "+1234567890",
    "ootb_status":"Started" /  "Completed",
    "ootb_registration_source": "product page",
    "ootb_date_of_birth": "1990-01-15",
    "ootb_allow_email": "Yes",
    "ootb_allow_sms": "Yes",
    "ootb_allow_push": "Yes",
    "ootb_allow_whatsapp": "Yes",
    "ootb_is_email_verified": "Yes",
    "ootb_is_mobile_verified": "Yes",
    "ootb_is_blocked": "No",
    "ootb_is_test": "No",
    "ootb_gender": "male",
    "ootb_country": "US",
    "ootb_city": "NYC",
    "ootb_address": "Street 1111",
    "ootb_first_name": "John",
    "ootb_last_name": "Doe",
    "ootb_language": "en",
    "ootb_currency": "USD",
    "ootb_brand": "",
    "ootb_alias": "johndoe90",
    "ootb_referral_type": "Advertising",
    "ootb_affiliate_id": "",
    "ootb_platform": "iOS",
    "ootb_promo_code": "WELCOME2024",
    "ootb_license": "licenseXYZ"
  }
}

Parameters

Parameter Key	Type	Description
`ootb_email`	String	The customer's email address.
`ootb_mobile_number`	String	The customer's mobile phone number.
`ootb_status`	String	Update status: `Started`, `Completed`, or `Failed`.
`ootb_registration_source`	String	Where the update was initiated (e.g., product page, checkout, header).
`ootb_date_of_birth`	String	The customer's date of birth in ISO format (YYYY-MM-DD).
`ootb_allow_email`	Boolean	Whether the customer consents to email notifications (`Yes`/`No`).
`ootb_allow_sms`	Boolean	Whether the customer consents to SMS notifications (`Yes`/`No`).
`ootb_allow_push`	Boolean	Whether the customer consents to push notifications (`Yes`/`No`).
`ootb_allow_whatsapp`	Boolean	Whether the customer consents to WhatsApp notifications (`Yes`/`No`).
`ootb_is_email_verified`	String	Indicates if the email address has been verified (`Yes`/`No`).
`ootb_is_mobile_verified`	String	Indicates if the mobile number has been verified (`Yes`/`No`).
`ootb_is_blocked`	Boolean	Indicates if the customer is blocked (`Yes`/`No`).
`ootb_is_test`	String	Indicates if this is a test account (`Yes`/`No`).
`ootb_gender`	String	The customer's gender (e.g., `male`, `female`, `other`).
`ootb_country`	String	The country code for the customer (e.g., `US`, `UK`).
`ootb_city`	String	The customer's city.
`ootb_address`	String	The customer's address.
`ootb_first_name`	String	The customer's first name.
`ootb_last_name`	String	The customer's last name.
`ootb_language`	String	The customer's language preference (e.g., `en`, `fr`).
`ootb_currency`	String	The customer's preferred currency code.
`ootb_brand`	String	Gaming brand identifier (optional—for gaming platforms).
`ootb_alias`	String	Gaming alias or username.
`ootb_referral_type`	String	How the user was referred (e.g., `SEO`, `Affiliate`, `Advertising`).
`ootb_affiliate_id`	String	Affiliate identifier or name.
`ootb_platform`	String	The platform used during update (e.g., `iOS`, `Android`, `Web`).
`ootb_promo_code`	String	Promotional code applied (if any).
`ootb_license`	String	License or regulation identifier.

Explanation

context:
- ootb_email: Captures the customer’s email address to keep their profile up to date.
- ootb_mobile_number: Stores the customer’s mobile phone number for SMS communications.
- ootb_status: Indicates whether the update process has Started or Completed.
- ootb_registration_source: Shows where the user initiated the update (product page, checkout, header, etc.).
- ootb_date_of_birth: Records the customer’s birth date in ISO format for age verification or personalization.
- ootb_allow_email, ootb_allow_sms, ootb_allow_push, ootb_allow_whatsapp: Boolean flags capturing the customer’s consent preferences for each communication channel.
- ootb_is_email_verified, ootb_is_mobile_verified: Flags indicating if the provided email or mobile number has been confirmed.
- ootb_is_blocked, ootb_is_test: Flags showing whether the account is blocked (e.g., for fraud) or is a test profile.
- ootb_gender, ootb_country, ootb_city, ootb_address: Demographic and location fields for personalization and compliance.
- ootb_first_name, ootb_last_name: The customer’s personal name details.
- ootb_language, ootb_currency: The customer’s language and currency preferences for localized experiences.
- ootb_brand, ootb_alias, ootb_referral_type, ootb_affiliate_id: Gaming-specific metadata and referral tracking information.
- ootb_platform, ootb_promo_code, ootb_license: Contextual fields showing the platform used, any promotional code applied, and relevant regulatory licensing.

Updated about 1 month ago