/
Contact usSee pricingStart building
    Introduction
    Overview
    Postman
    Organizations
      Organization object
      Create an organization
      Get an organization
      Update an organization
      Search for organizations
      Delete an organization
    Members
      Member object
      Create a Member
      Get a Member
      Get a Member (Dangerous)
      Update a Member
      Reactivate a Member
      Search for Members
      Unlink Retired Email
      Start Member Email Update

    • Delete

        • Delete a Member
        Delete Member password
        Delete Member MFA phone number
        Delete Member MFA TOTP
    RBAC
      Resource object
      Role object
      Scope object
      Get RBAC Policy
    Email magic links

    • Organization

        • Send login or signup email
        Send invite email
        Authenticate Magic Link

    • Discovery

        • Send discovery email
        Authenticate discovery Magic Link
    Email one-time passcodes (OTP)

    • Organization

        • Send login or signup OTP
        Authenticate OTP

    • Discovery

        • Send discovery OTP
        Authenticate discovery OTP
    OAuth

    • Discovery

        • Use Google for discovery
        Use Microsoft for discovery
        Use HubSpot for discovery
        Use Slack for discovery
        Use GitHub for discovery
        Authenticate discovery OAuth

    • Organization

        • Login with Google
        Login with Microsoft
        Login with HubSpot
        Login with Slack
        Login with GitHub
        Authenticate OAuth

    • Token

        • Get Google Access Token
        Get Microsoft Access Token
        Get HubSpot Access Token
        Get Slack Access Token
        Get GitHub Access Token
    Session management
      Session object
      Get JWKS
      Get Session
      Authenticate Session
      Exchange Session
      Revoke Session
      Migrate Session
      Attest Session
    Single sign-on (SS0)
      SAML Connection object
      OIDC Connection object
      External Connection object

    • SAML

        • Create SAML Connection
        Update SAML Connection
        Update SAML Connection by Metadata URL
        Delete SAML Verification Certificate

    • OIDC

        • Create OIDC Connection
        Update OIDC Connection
        Get OIDC Access Token

    • External

        • Create External Connection
        Update External Connection

    • Shared

        • Get SSO Connections
        Delete SSO Connection
        Start SSO Authenticate
        Complete SSO Authenticate
    SCIM
      SCIM Connection Object

    • Connection management

        • Create SCIM Connection
        Update SCIM Connection
        Delete SCIM Connection
        Get SCIM Connection

    • Token management

        • Start SCIM Token Rotation
        Complete SCIM Token Rotation
        Cancel SCIM Token Rotation

    • SCIM groups

        • Get SCIM Connection Groups
    Discovery
      Discovered Organization object
      Create Organization via Discovery
      List Organizations
      Exchange Intermediate Session
    Passwords
      Authenticate
      Discovery Authenticate
      Strength check
      Migrate

    • Create or Reset Options

        • Password reset by email start
        Password reset by email
        Password reset by existing password
        Password reset by session
        Discovery Password reset by email start
        Discovery Password reset by email
        Require Password reset by email
    Multi-Factor Authentication (MFA)

    • One-time passcodes

        • Send SMS OTP
        Authenticate SMS OTP

    • Time-based one-time passcodes

        • Create TOTP
        Authenticate TOTP
        Migrate TOTP

    • Recovery codes

        • Get recovery codes
        Recover
        Rotate recovery codes
    M2M Authentication
      M2M Client Object

    • TOKEN

        • Get Access Token
        Authenticate Access Token

    • M2M Client

        • Create M2M client
        Get M2M client
        Search M2M clients
        Update M2M client
        Delete M2M client

    • Rotate secret

        • Start secret rotation
        Rotate secret
        Cancel secret rotation
    Connected AppsBeta
      Get Access Token

    • Tokens

        • Connected App ID Token Object
        Connected App Access Token Object

    • Configuration

        • Get JWKS
        Get OpenID Configuration

    • Methods

        • Introspect Token
        Authenticate Access Token (Local)
        Exchange Access Token
        Revoke Token
        Get UserInfo

    • Consent Management

        • Get Authorized Connected Apps for an Organization
        Get Connected App Details
        Get Authorized Connected Apps for a Member
        Revoke Connected App Access to a Member

    • Application Management

        • Dynamic Client Registration
        Create Connected App
        Get Connected App
        Search Connected Apps
        Update Connected App
        Delete Connected App

    • Rotate secret

        • Start secret rotation
        Rotate secret
        Cancel secret rotation
    Impersonation
      Authenticate Token
    Resources
      Organization authentication settings
      Common email domains
      Member states
      Email templates
      URL validation
      Metadata
      SAML overview
      SAML Certificates
    Errors
      Overview
      Error object
      400
      401
      403
      404
      405
      429
      499
      500
      503
Get support on SlackVisit our developer forum

Contact us

B2B Saas Authentication

/

API reference

/

Members

/

Start Member Email Update

Start a self-serve email update

POST
https://test.stytch.com/v1/b2b/organizations/{organization_id}/members/{member_id}/start_email_update

Starts a self-serve email update for a Member specified by their organization_id and member_id. To perform a self-serve update, members must be active and have an active, verified email address.

The new email address must meet the following requirements:

  • Must not be in use by another member (retired emails count as used until they are unlinked)
  • Must not be updating for another member (i.e. two members cannot attempt to update to the same email at once)

The member will receive an Email Magic Link that expires in 5 minutes. If they do not verify their new email address in that timeframe, the email will be freed up for other members to use.

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.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.

Path parameters

organization_id* string
member_id* string

Body parameters

email_address* string
login_redirect_url string
login_template_id string
locale string

Header parameters

X-Stytch-Member-Session string
X-Stytch-Member-SessionJWT string

Response fields

request_id string
status_code int
member_id string
member object
organization object
const stytch = require('stytch');

const client = new stytch.B2BClient({
  project_id: 'PROJECT_ID',
  secret: 'SECRET',
});

const params = {
  organization_id: "organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931",
  member_id: "member-test-32fc5024-9c09-4da3-bd2e-c9ce4da9375f",
  email_address: "sandbox@stytch.com",
};

const options = {
  authorization: {
    session_token: 'mZAYn5aLEqKUlZ_Ad9U_fWr38GaAQ1oFAhT8ds245v7Q',
  },
};

client.organizations.members.startEmailUpdate(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });
RESPONSE
200
​
{
  "status_code": 200,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "member_id": "member-test-32fc5024-9c09-4da3-bd2e-c9ce4da9375f",
  "member": {...},
  "organization": {...}
}