Skip to content

com.atproto.server.updateEmail

Lexicon Version: 1

Type: procedure

Update an account’s email.

Parameters: (None defined)

Input:

  • Encoding: application/json
  • Schema:

Schema Type: object

NameTypeReq’dDescriptionConstraints
emailstring
emailAuthFactorboolean
tokenstringRequires a token from com.atproto.sever.requestEmailUpdate if the account’s email has been confirmed.
Possible Errors:
  • ExpiredToken
  • InvalidToken
  • TokenRequired

{
"lexicon": 1,
"id": "com.atproto.server.updateEmail",
"defs": {
"main": {
"type": "procedure",
"description": "Update an account's email.",
"input": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string"
},
"emailAuthFactor": {
"type": "boolean"
},
"token": {
"type": "string",
"description": "Requires a token from com.atproto.sever.requestEmailUpdate if the account's email has been confirmed."
}
}
}
},
"errors": [
{
"name": "ExpiredToken"
},
{
"name": "InvalidToken"
},
{
"name": "TokenRequired"
}
]
}
}
}