You are here:

Home

/

Documentation

/

Manage account

Manage account

These endpoints help users manage account lifecycle tasks.

You can schedule automatic account deletion, prune journals while keeping login access, or permanently delete the account.

Auto delete the account

This endpoint toggles automatic account deletion for the authenticated user.

URL parameters

This endpoint does not have any parameters.

Query parameters

auto_delete_account boolean required

Set to true to enable automatic deletion, or false to disable it.

Response attributes

message string

Confirmation message for the auto-delete change.

status integer

HTTP status code.

PUT /api/settings/security/auto-delete-account
{
"message" : "Changes saved" ,
"status" : 200
}

Prune the account

This endpoint removes all journals for the authenticated user.

URL parameters

This endpoint does not have any parameters.

Query parameters

No query parameters are available for this endpoint.

Response attributes

message string

Confirmation message for the prune request.

status integer

HTTP status code.

PUT /api/settings/prune
{
"message" : "The account has been pruned" ,
"status" : 200
}

Delete the account

This endpoint permanently deletes the authenticated user account.

URL parameters

This endpoint does not have any parameters.

Query parameters

reason string required

Reason for deleting the account. Minimum 3 characters.

Response attributes

message string

Confirmation message for the delete request.

status integer

HTTP status code.

DELETE /api/settings/account
{
"message" : "The account has been deleted" ,
"status" : 200
}