update

abstract suspend fun update(memberId: String, request: IOrganizationsAdminMemberUpdateParameters): OrganizationsAdminMemberUpdateResponse

Updates profile fields on any member in the organization. Calls the PUT /sdk/v1/b2b/organizations/members/{member_id} endpoint. Requires an active session and appropriate RBAC permissions.

Kotlin:

StytchB2B.members.admin.update(
memberId = "member-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
request = OrganizationsAdminMemberUpdateParameters(
preserveExistingSessions = true,
name = "Jane Doe",
),
)

iOS:

let params = OrganizationsAdminMemberUpdateParameters(preserveExistingSessions: true, name: "Jane Doe")
let response = try await StytchB2B.members.admin.update(
memberId: "member-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
request: params
)

React Native:

StytchB2B.members.admin.update(
"member-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
{ preserveExistingSessions: true, name: "Jane Doe" }
)

Return

OrganizationsAdminMemberUpdateResponse containing the updated member object.

Parameters

memberId

The unique ID of the member to update.

request
  • IOrganizationsAdminMemberUpdateParameters

  • preserveExistingSessions — Whether to keep existing sessions active after the update.

  • name? — Updated display name.

  • mfaEnrolled? — Whether MFA is enrolled.

  • mfaPhoneNumber? — Updated MFA phone number.

  • untrustedMetadata? — Client-settable key-value metadata.

  • isBreakglass? — Whether this is a breakglass account.

  • roles? — List of RBAC role IDs to assign.

  • defaultMfaMethod? — The default MFA method.

  • emailAddress? — Updated email address.

  • unlinkEmail? — Whether to unlink the current primary email.

Throws

StytchError

if the request fails or the caller lacks permission.

if the coroutine is cancelled.