unlinkRetiredEmail

abstract suspend fun unlinkRetiredEmail(memberId: String, request: IOrganizationsAdminMemberUnlinkRetiredEmailParameters): OrganizationsAdminMemberUnlinkRetiredEmailResponse

Removes a retired (previously used) email address from the specified member's account. Calls the POST /sdk/v1/b2b/organizations/members/{member_id}/unlink_retired_email endpoint. Requires an active session and appropriate RBAC permissions.

Kotlin:

StytchB2B.members.admin.unlinkRetiredEmail(
memberId = "member-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
request = OrganizationsAdminMemberUnlinkRetiredEmailParameters(emailAddress = "old@example.com"),
)

iOS:

let params = OrganizationsAdminMemberUnlinkRetiredEmailParameters(emailAddress: "old@example.com")
let response = try await StytchB2B.members.admin.unlinkRetiredEmail(
memberId: "member-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
request: params
)

React Native:

StytchB2B.members.admin.unlinkRetiredEmail(
"member-test-d5a3b680-e8a3-40c0-b815-ab79986666d0",
{ emailAddress: "old@example.com" }
)

Return

OrganizationsAdminMemberUnlinkRetiredEmailResponse containing the updated member object.

Parameters

memberId

The unique ID of the member whose retired email to remove.

request
  • IOrganizationsAdminMemberUnlinkRetiredEmailParameters

  • emailId? — The ID of the retired email to unlink.

  • emailAddress? — The address of the retired email to unlink.

Throws

StytchError

if the request fails or the caller lacks permission.

if the coroutine is cancelled.