ZITADEL Docs
APIsCore ResourcesV2User

SetEmail

Change the user email

Deprecated: Update the users email field.

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

POST
/v2/users/{user_id}/email

Path Parameters

user_id*string

Request Body

application/json

email?string
isVerified*boolean
[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/v2/users/string/email" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "isVerified": true  }'
{
  "details": {
    "sequence": 0,
    "changeDate": "1s",
    "resourceOwner": "string",
    "creationDate": "1s"
  },
  "verificationCode": "string"
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?