# club.hellyeah.account.requestLink

> Emails a sign-in link. With no account on the address, opening it claims an account with that email. Answers the same either way.

- Kind: procedure
- Authority: account.hellyeah.club
- Lexicon: 1
- Published by [hellyeah.club](https://lexicon.garden/identity/did:plc:ce2gpmv3q5a4xlnpt63e4nsn), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:ce2gpmv3q5a4xlnpt63e4nsn/club.hellyeah.account.requestLink)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:ce2gpmv3q5a4xlnpt63e4nsn/club.hellyeah.account.requestLink/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:ce2gpmv3q5a4xlnpt63e4nsn/club.hellyeah.account.requestLink/analytics)

## Procedure (`club.hellyeah.account.requestLink`)

Type: procedure · POST

### Input (application/json)

- `email` (string, required)
- `next` (string): A path on this site to go to after.
- `notify` (boolean): For a new claim: email once when invites start going out.

### Output (application/json)


### Errors

- `InvalidEmail`: No description in schema.
- `RateLimited`: 3 sign-in emails have gone to this address in the last hour.
- `EmailFailed`: No description in schema.

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Emails a sign-in link. With no account on the address, opening it claims an account with that email. Answers the same either way.",
      "errors": [
        {
          "name": "InvalidEmail"
        },
        {
          "description": "3 sign-in emails have gone to this address in the last hour.",
          "name": "RateLimited"
        },
        {
          "name": "EmailFailed"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "email": {
              "type": "string"
            },
            "next": {
              "description": "A path on this site to go to after.",
              "type": "string"
            },
            "notify": {
              "description": "For a new claim: email once when invites start going out.",
              "type": "boolean"
            }
          },
          "required": [
            "email"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {},
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "club.hellyeah.account.requestLink",
  "lexicon": 1
}
```
