tridion-sites-extensions-api-docs

Home > @tridion-sites/open-api-client > UserProfileService > updateUserProfile

UserProfileService.updateUserProfile() method

Beta version. Updates certain properties in a user’s profile. This operation returns an instance of ‘UserProfile’ type.

Only ‘Preferences.Favorites’ property can be updated through this operation.

Signature:

static updateUserProfile({ escapedUserId, userProfile, }: {
        escapedUserId: string;
        userProfile: UserProfile;
    }): CancelablePromise<UserProfile>;

Parameters

Parameter	Type	Description
{ escapedUserId, userProfile, }	{ escapedUserId: string; userProfile: UserProfile; }

Returns:

CancelablePromise<UserProfile>

UserProfile The request was successful.

Exceptions

ApiError