# social.colibri.actor.deleteAccount

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.deleteAccount)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.deleteAccount/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.actor.deleteAccount/examples)

## Definitions

### `social.colibri.actor.deleteAccount`

**Type**: `procedure`

Deletes everything the AppView holds for the authenticated user.

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `deleted` | `ref` → `lex:social.colibri.actor.deleteAccount#deletedCounts` | Yes |  |

#### Errors

- **AuthRequired**: Missing, malformed, or unverifiable service auth.
- **InvalidState**: The request is not valid for the current state.

### `social.colibri.actor.deleteAccount#deletedCounts`

**Type**: `object`

What the purge removed, per storage area.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `userState` | `integer` | Yes |  |
| `recordData` | `integer` | Yes |  |
| `invitations` | `integer` | Yes |  |
| `notifications` | `integer` | Yes |  |
| `communityRecords` | `integer` | Yes |  |
| `pushSubscriptions` | `integer` | Yes |  |
| `dismissedApplications` | `integer` | Yes |  |

## Raw Schema

```json
{
  "id": "social.colibri.actor.deleteAccount",
  "defs": {
    "main": {
      "type": "procedure",
      "errors": [
        {
          "name": "AuthRequired",
          "description": "Missing, malformed, or unverifiable service auth."
        },
        {
          "name": "InvalidState",
          "description": "The request is not valid for the current state."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "deleted"
          ],
          "properties": {
            "deleted": {
              "ref": "lex:social.colibri.actor.deleteAccount#deletedCounts",
              "type": "ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Deletes everything the AppView holds for the authenticated user."
    },
    "deletedCounts": {
      "type": "object",
      "required": [
        "recordData",
        "communityRecords",
        "notifications",
        "pushSubscriptions",
        "userState",
        "invitations",
        "dismissedApplications"
      ],
      "properties": {
        "userState": {
          "type": "integer"
        },
        "recordData": {
          "type": "integer"
        },
        "invitations": {
          "type": "integer"
        },
        "notifications": {
          "type": "integer"
        },
        "communityRecords": {
          "type": "integer"
        },
        "pushSubscriptions": {
          "type": "integer"
        },
        "dismissedApplications": {
          "type": "integer"
        }
      },
      "description": "What the purge removed, per storage area."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
