Skip to main content

Change the user email​

Change the email address of a user. If the state is set to not verified, a verification code will be generated, which can be either returned or sent to the user by email.

Path Parameters
    userId string required
Request Body required
    email string required

    Possible values: non-empty and <= 200 characters

    sendCode object
    urlTemplate string

    Possible values: non-empty and <= 200 characters

    "Optionally set a url_template, which will be used in the verification mail sent by ZITADEL to guide the user to your verification page. If no template is set, the default ZITADEL url will be used."

    returnCode object
    isVerified boolean
Responses

OK

Schema
    details object
    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    resourceOwner resource_owner is the organization or instance_id an object belongs to
    verificationCode in case the verification was set to return_code, the code will be returned
POST /v2beta/users/:userId/email

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN
Bearer Token
userId — path required
Content-Type
Body required
{

  "email": "mini@mouse.com",

  "sendCode": {

    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"

  },

  "returnCode": {},

  "isVerified": true

}
Accept
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/v2beta/users/:userId/email' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "email": "mini@mouse.com",
  "sendCode": {
    "urlTemplate": "https://example.com/email/verify?userID={{.UserID}}&code={{.Code}}&orgID={{.OrgID}}"
  },
  "returnCode": {},
  "isVerified": true
}'