Ask for the account to be deleted, a week from now

This page as Markdown, or in an AI chatMore ways to read this page

Ask for the account to be deleted, a week from now. Owners only.

# Ask for the account to be deleted, a week from now

> tidekeeper's API reference: https://tidekeeper.eu/docs/api/post-account-deletion

`POST /api/v1/account/deletion`

Ask for the account to be deleted, a week from now. Owners only.

## What to send

`DeletionAsk`: The account's name, typed to say that deleting it is meant.

- `name` (string, needed)

## The answer

200, `AccountView`: What an account is, to its members.

- `delete_days` (integer, needed): How many days an owner's own wish to delete waits.
- `deletion` (Deletion or null)
- `id` (string, needed)
- `instance` (boolean): The account of whoever runs this tidekeeper. It is not deleted from here: it goes when the instance does.
- `name` (string, needed)
- `pending` (boolean): It is new and waits for whoever runs this tidekeeper to approve it: nothing is counted until then.
- `suspended` (Suspended or null)

## Asking

```sh
curl -X POST https://tidekeeper.eu/api/v1/account/deletion \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "…"}'
```

What to send

DeletionAsk The account's name, typed to say that deleting it is meant.

name: stringneeded

The answer

Status 200

AccountView What an account is, to its members.

delete_days: integerneededHow many days an owner's own wish to delete waits.
deletion: Deletion or null
id: stringneeded
instance: booleanThe account of whoever runs this tidekeeper. It is not deleted from here: it goes when the instance does.
name: stringneeded
pending: booleanIt is new and waits for whoever runs this tidekeeper to approve it: nothing is counted until then.
suspended: Suspended or null

Asking

curlJavaScript

With your token from Settings

curl -X POST https://tidekeeper.eu/api/v1/account/deletion \
    -H "Authorization: Bearer $TIDEKEEPER_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name": "…"}'

With your token from Settings

const answer = await fetch("https://tidekeeper.eu/api/v1/account/deletion", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.TIDEKEEPER_TOKEN}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"name": "…"}),
}).then((r) => r.json());