Skip to content

docs(sdk): document account.delete() trash-by-default behavior #1060

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jiashuoz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(sdk): document account.delete() trash-by-default behavior #1060

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions sdks/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -446,6 +446,24 @@ guard for you:
await client.messages.delete("bot@agents.e2a.dev", "msg_abc123", permanent=True)
```

`client.account.delete()` follows the same trash-by-default pattern: every
API key, OAuth grant, and dashboard session is revoked at once, every agent
is trashed, and sending stops immediately, but the account itself stays
restorable by signing in to the dashboard before the receipt's
`purge_after` (API keys stay revoked and custom domains must be
re-verified after a restore; there is no API restore call). Pass
`permanent=True` for the old behavior — irreversible erasure right away
(both the async and sync clients accept the keyword-only argument):

```python
receipt = await client.account.delete() # mode: "trash", purge_after set
await client.account.delete(permanent=True) # mode: "permanent", erased at once
```

`messages_deleted` is always `0` on the trash path; the other counts on
`DeleteUserDataResult` describe rows trashed/revoked/unverified rather than
deleted, and `user_deleted` is `True` only for `mode="permanent"`.

## WebSocket (real-time delivery for local agents)

```python
Expand Down
17 changes: 17 additions & 0 deletions sdks/typescript/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,23 @@ trashed agents):
await client.agents.delete("bot@agents.e2a.dev", { permanent: true });
```

`account.delete()` follows the same trash-by-default pattern: every API key,
OAuth grant, and dashboard session is revoked at once, every agent is
trashed, and sending stops immediately, but the account itself stays
restorable by signing in to the dashboard before the receipt's `purgeAfter`
(API keys stay revoked and custom domains must be re-verified after a
restore; there is no API restore call). Pass `{ permanent: true }` for the
old behavior — irreversible erasure right away:

```ts
const receipt = await client.account.delete(); // mode: "trash", purgeAfter set
await client.account.delete({ permanent: true }); // mode: "permanent", erased at once
```

`messagesDeleted` is always `0` on the trash path; the other counts on
`DeleteUserDataResult` describe rows trashed/revoked/unverified rather than
deleted, and `userDeleted` is `true` only for `mode: "permanent"`.

## Application correlation and email threads

`conversationId` is an optional, caller-owned opaque value for correlating mail
Expand Down
Loading