Lexicon Garden

com.atproto.server.updateEmail

Update an account's email.

Repository @atproto-lexicons.bsky.social did:plc:6msi3pj7krzih5qxqtryxlzw namespace authority
Details · procedure
Kindprocedure
Authorityserver.atproto.com
Indexed
Compare Edit in builder → Fork →
cid bafyreia57t6r2crv7hinanwkcfyhqfcbt3qnfqponrj3j5owwlepnbxb7u

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.emailNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.input.schema.properties.tokenNo maxLength, maxGraphemes or format limits this string.
  • endpoint-output-undefined defs.mainNo output is defined. Endpoints should define one, even an empty one.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Update an account's email.",
      "errors": [
        {
          "name": "ExpiredToken"
        },
        {
          "name": "InvalidToken"
        },
        {
          "name": "TokenRequired"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "email": {
              "type": "string"
            },
            "emailAuthFactor": {
              "type": "boolean"
            },
            "token": {
              "description": "Requires a token from com.atproto.sever.requestEmailUpdate if the account's email has been confirmed.",
              "type": "string"
            }
          },
          "required": [
            "email"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "com.atproto.server.updateEmail",
  "lexicon": 1
}