Unlinks a retired email address from a Member specified by their organization_id and member_id. The email address to be retired can be identified in the request body by either its email_id, its email_address, or both. If using both identifiers they must refer to the same email.
A previously active email address can be marked as retired in one of two ways:
It's replaced with a new primary email address during an explicit Member update.
- A new email address is surfaced by an OAuth, SAML or OIDC provider. In this case the new email address becomes the Member's primary email address and the old primary email address is retired.
A retired email address cannot be used by other Members in the same Organization. However, unlinking retired email addresses allows them to be subsequently re-used by other Organization Members. Retired email addresses can be viewed on the Member object.
RBAC Enforced API
When a Member Session is passed in the Authorization headers, Stytch will enforce that the Member has permission to take the update.info.unlink.retired-email Action on the stytch.member or stytch.self (depending on the target MemberID) Resource prior to honoring the request.
To learn more, see our RBAC guide.