Update an end-user status (suspend / activate).

PATCHhttps://app.softsolz.uk/api/v1/services/customer-auth/users/{id}

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Body Params

statusstringrequired

New account status. Suspending revokes all sessions.

Response

Response Body

idstringEnd-user id.

emailstringEnd-user email.

namestring | nullDisplay name.

profile_picture_urlstring | nullAvatar URL.

statusstringAccount status.

email_verified_atstring | nullWhen the email was verified.

mfa_enabledbooleanWhether TOTP MFA is enabled.

mfa_enabled_atstring | nullWhen TOTP MFA was enabled.

last_login_atstring | nullLast successful login.

created_atstringCreation timestamp.

updated_atstringLast update timestamp.

metadataobjectTenant-defined metadata bag.

Request

curl --request PATCH \
  --url https://app.softsolz.uk/api/v1/services/customer-auth/users/{id} \
  --header 'Authorization: Bearer sk_live_your_key' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "suspended"
}'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": {
    "id": "1042",
    "email": "user@example.com",
    "name": "Jane Doe",
    "profile_picture_url": null,
    "status": "active",
    "email_verified_at": "2026-01-01T00:00:00.000Z",
    "mfa_enabled": false,
    "mfa_enabled_at": null,
    "last_login_at": null,
    "created_at": "2026-01-01T00:00:00.000Z",
    "updated_at": "2026-01-01T00:00:00.000Z",
    "metadata": {}
  }
}