Clerk Android/com.clerk.user/User/UpdateParams

UpdateParams

@Serializable
data class UpdateParams(val firstName: String? = null, val lastName: String? = null, val username: String? = null, val primaryEmailAddressId: String? = null, val primaryPhoneNumberId: String? = null, val profileImageId: String? = null, val publicMetadata: String? = null, val privateMetadata: String? = null)

Parameters for updating a user's profile information.

All fields are optional - only provide the fields you want to update. Null values will be ignored and the existing values will be preserved.

Constructors

Link copied to clipboard
constructor(firstName: String? = null, lastName: String? = null, username: String? = null, primaryEmailAddressId: String? = null, primaryPhoneNumberId: String? = null, profileImageId: String? = null, publicMetadata: String? = null, privateMetadata: String? = null)

Properties

Link copied to clipboard
@SerialName(value = "first_name")
val firstName: String? = null

The user's first name.

Link copied to clipboard
@SerialName(value = "last_name")
val lastName: String? = null

The user's last name.

Link copied to clipboard
@SerialName(value = "primary_email_address_id")
val primaryEmailAddressId: String? = null

The ID for the EmailAddress to be set as primary.

Link copied to clipboard
@SerialName(value = "primary_phone_number_id")
val primaryPhoneNumberId: String? = null

The ID for the PhoneNumber to be set as primary.

Link copied to clipboard
@SerialName(value = "private_metadata")
val privateMetadata: String? = null

JSON string containing private metadata to update.

Link copied to clipboard
@SerialName(value = "profile_image_id")
val profileImageId: String? = null

The ID for the image to be set as profile image.

Link copied to clipboard
@SerialName(value = "public_metadata")
val publicMetadata: String? = null

JSON string containing public metadata to update.

Link copied to clipboard
val username: String? = null

The user's username.