Stytch · Schema

api_organization_v1_organizations_members_StartEmailUpdateRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
email_address string The new email address for the Member.
login_redirect_url string The URL that the Member clicks from the login Email Magic Link. This URL should be an endpoint in the backend server that verifies the request by querying Stytch's authenticate endpoint and finishes t
locale object Used to determine which language to use when sending the user this delivery method. Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `"en"`. C
login_template_id string Use a custom template for login emails. By default, it will use your default email template. Templates can be added in the [Stytch dashboard](https://stytch.com/dashboard/templates) using our built-in
delivery_method object The method that should be used to verify a member's new email address. The options are `EMAIL_MAGIC_LINK` or `EMAIL_OTP`. This field is optional, if no value is provided, `EMAIL_MAGIC_LINK` will be us
View JSON Schema on GitHub

JSON Schema

stytch-api-organization-v1-organizations-members-startemailupdatere-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_organization_v1_organizations_members_StartEmailUpdateRequest",
  "title": "api_organization_v1_organizations_members_StartEmailUpdateRequest",
  "type": "object",
  "properties": {
    "email_address": {
      "type": "string",
      "description": "The new email address for the Member."
    },
    "login_redirect_url": {
      "type": "string",
      "description": "The URL that the Member clicks from the login Email Magic Link. This URL should be an endpoint in the backend server that\n  verifies the request by querying Stytch's authenticate endpoint and finishes the login. If this value is not passed, the default login\n  redirect URL that you set in your Dashboard is used. If you have not set a default login redirect URL, an error is returned."
    },
    "locale": {
      "$ref": "#/components/schemas/api_organization_v1_StartEmailUpdateRequestLocale",
      "description": "Used to determine which language to use when sending the user this delivery method. Parameter is an [IETF BCP 47 language tag](https://www.w3.org/International/articles/language-tags/), e.g. `\"en\"`.\n\nCurrently supported languages are English (`\"en\"`), Spanish (`\"es\"`), French (`\"fr\"`) and Brazilian Portuguese (`\"pt-br\"`); if no value is provided, the copy defaults to English.\n\nRequest support for additional languages [here](https://docs.google.com/forms/d/e/1FAIpQLScZSpAu_m2AmLXRT3F3kap-s_mcV6UTBitYn6CdyWP0-o7YjQ/viewform?usp=sf_link\")!\n"
    },
    "login_template_id": {
      "type": "string",
      "description": "Use a custom template for login emails. By default, it will use your default email template. Templates can be added in the [Stytch dashboard](https://stytch.com/dashboard/templates) using our built-in customization options or custom HTML templates with type \u201cMagic Links - Login\u201d."
    },
    "delivery_method": {
      "$ref": "#/components/schemas/api_organization_v1_StartEmailUpdateRequestDeliveryMethod",
      "description": "The method that should be used to verify a member's new email address. The options are `EMAIL_MAGIC_LINK` or `EMAIL_OTP`. This field is optional, if no value is provided, `EMAIL_MAGIC_LINK` will be used."
    }
  },
  "description": "Request type",
  "required": [
    "email_address"
  ]
}