STstytch
User

Exchangeprimaryfactor

Changed on

Exchange a user's email address or phone number for another.

Must pass either an email_address or a phone_number.

This endpoint only works if the user has exactly one factor. You are able to exchange the type of factor for another as well, i.e. exchange an email_address for a phone_number.

Use this endpoint with caution as it performs an admin level action.

put/v1/users/{user_id}/exchange_primary_factor

Request

  • Base URL
    https://api.stytch.com
  • Auth
    HTTP basic

Path parameters

user_idstring required

The unique ID of a specific User. You may use an external_id here if one is set for the user.

Request body

email_addressstring

The email address to exchange to.

phone_numberstring

The phone number to exchange to. The phone number should be in E.164 format (i.e. +1XXXXXXXXXX).

Response

Successful response

request_idstring required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

user_idstring required

The unique ID of the affected User.

status_codeinteger required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

Changes