# at.happyproto.actor.removeContactEmail

> Remove the caller's contact email. Their preferences space keeps a contact record with no address, so sign-in does not write one back, and every proof and open link is forgotten. The address on their PDS account is untouched. Customers and staff; anyone else is refused.

- Kind: procedure
- Authority: actor.happyproto.at
- Lexicon: 1
- Published by [happyproto.at](https://lexicon.garden/identity/did:plc:mo7vq4jbioxwafy5zkcc3eux), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.actor.removeContactEmail)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.actor.removeContactEmail/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.actor.removeContactEmail/analytics)

## Procedure (`at.happyproto.actor.removeContactEmail`)

Type: procedure · POST

### Input (application/json)

- `idempotencyKey` (string, required): A UUID the client generates once per action and resends on every retry of it.

### Output (application/json)

- `removed` (boolean, required): Always true on success.

### Errors

- `AuthRequired`: This endpoint requires an authenticated caller.
- `Forbidden`: The caller is neither a customer nor staff, or the provisioner refused them.
- `InvalidRequest`: The input is malformed, or the provisioner refused it as malformed.
- `EmailNotConfigured`: Owner email is not switched on yet.
- `InvalidEmail`: Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.
- `TooManyLinks`: Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.
- `InvalidLink`: Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.
- `ExpiredLink`: Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.
- `EmailFailed`: Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.
- `NotFound`: Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.
- `InvalidSlug`: Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.
- `SlugTaken`: Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.
- `NotEntitled`: Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.
- `InstanceLimit`: Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.
- `NoCapacity`: Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.
- `OperationInProgress`: Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.
- `Upstream`: The preferences space or the provisioner could not be reached, or answered with an error it does not explain to callers.

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Remove the caller's contact email. Their preferences space keeps a contact record with no address, so sign-in does not write one back, and every proof and open link is forgotten. The address on their PDS account is untouched. Customers and staff; anyone else is refused.",
      "errors": [
        {
          "description": "This endpoint requires an authenticated caller.",
          "name": "AuthRequired"
        },
        {
          "description": "The caller is neither a customer nor staff, or the provisioner refused them.",
          "name": "Forbidden"
        },
        {
          "description": "The input is malformed, or the provisioner refused it as malformed.",
          "name": "InvalidRequest"
        },
        {
          "description": "Owner email is not switched on yet.",
          "name": "EmailNotConfigured"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.",
          "name": "InvalidEmail"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.",
          "name": "TooManyLinks"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.",
          "name": "InvalidLink"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.",
          "name": "ExpiredLink"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.",
          "name": "EmailFailed"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "NotFound"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "InvalidSlug"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "SlugTaken"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "NotEntitled"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "InstanceLimit"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "NoCapacity"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "OperationInProgress"
        },
        {
          "description": "The preferences space or the provisioner could not be reached, or answered with an error it does not explain to callers.",
          "name": "Upstream"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "idempotencyKey": {
              "description": "A UUID the client generates once per action and resends on every retry of it.",
              "type": "string"
            }
          },
          "required": [
            "idempotencyKey"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "removed": {
              "description": "Always true on success.",
              "type": "boolean"
            }
          },
          "required": [
            "removed"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "at.happyproto.actor.removeContactEmail",
  "lexicon": 1
}
```
