Clerk Android API/com.clerk.api.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, val unsafeMetadata: 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

UpdateParams

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, unsafeMetadata: String? = null)

Properties

firstName

@SerialName(value = "first_name")

val firstName: String?

The user's first name.

lastName

@SerialName(value = "last_name")

val lastName: String?

The user's last name.

primaryEmailAddressId

@SerialName(value = "primary_email_address_id")

val primaryEmailAddressId: String?

The ID for the EmailAddress to be set as primary.

primaryPhoneNumberId

@SerialName(value = "primary_phone_number_id")

val primaryPhoneNumberId: String?

The ID for the PhoneNumber to be set as primary.

privateMetadata

@SerialName(value = "private_metadata")

val ~~privateMetadata~~: String?

Private metadata. Never settable from the Frontend API — modifications must be made via the Backend API.

profileImageId

@SerialName(value = "profile_image_id")

val profileImageId: String?

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

publicMetadata

@SerialName(value = "public_metadata")

val ~~publicMetadata~~: String?

Public metadata. Never settable from the Frontend API — modifications must be made via the Backend API.

unsafeMetadata

@SerialName(value = "unsafe_metadata")

val ~~unsafeMetadata~~: String?

JSON string containing unsafe metadata to update. Passing this here is deprecated: the SDK now routes it through updateMetadata under the hood. Migrate calls to User.updateMetadata for clearer intent and direct access to deep-merge semantics.

username

val username: String?

The user's username.