Reset account

Resets all financial data (accounts, categories, merchants, tags, etc.) for the current user’s family while keeping the user account intact. The reset runs asynchronously in the background. The returned job_id is informational only; reset status is family-scoped, not job-scoped. Requires admin role.

DELETE /api/v1/users/reset

Reset account

cURL

curl --request DELETE \
  --url https://app.sure.am/api/v1/users/reset \
  --header 'X-Api-Key: <api-key>'

200

{
  "message": "<string>",
  "status": "queued",
  "job_id": "<string>",
  "family_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status_url": "<string>"
}

Authorizations

X-Api-Key · string · header · required

API key for authentication. Generate one from your account settings.

Response

200

application/json

account reset initiated

message · string · required

status · enum<string> · required

Available options: queued

job_id · string · required

Informational Active Job identifier returned by the queue adapter; reset status is family-scoped, not job-scoped.

family_id · string<uuid> · required

UUID of the family being reset.

status_url · string · required