Keys
Delete your account
Deletes the account and everything it holds, the organisations it owns alone included.
POST
/user/deleteTL;DR
| Question | Answer |
|---|---|
| What does it do? | Delete your account. |
| What does it take? | A JSON body of type DeleteAccountBody. |
| What does it return? | Status 204 with no body. |
| What can go wrong? | 400 what was typed is not the account's address (account.confirmation_mismatch); 401 not signed in; 403 the request came from an origin that may not make changes; 409 a paid plan is active (account.subscription_active), or an organisation it owns has other people in it (account.owns_shared_orgs); 429 too many requests; 503 hosting is not set up on this server. Every failure uses the one error envelope. |
What it does
Deletes the account and everything it holds, the organisations it owns alone included. confirm must be the account's address. Refused while a paid plan is active, and while it owns an organisation anyone else is in.
Request body
The body has the type DeleteAccountBody.
| Field | Type | Required | Description |
|---|---|---|---|
confirm | string | yes | at most 254 characters. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 204 | Deleted. | none |
| 400 | What was typed is not the account's address (account.confirmation_mismatch). | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | The request came from an origin that may not make changes. | ErrorResponse |
| 409 | A paid plan is active (account.subscription_active), or an organisation it owns has other people in it (account.owns_shared_orgs). | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Hosting is not set up on this server. | ErrorResponse |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |