FAfatzebra
Users

Deactivate a user

Locks the account so the user can't sign in. No body is expected.

post/users/{id}/deactivate

Request

  • Base URL
    https://gateway.pmnts.io/v2/partners
  • URL
    https://gateway.pmnts.io/v2/partners/users/{id}/deactivate
  • Auth
    HTTP basic

Response

The deactivated user.

idstring required

User id (e.g. 123-RU-9f3k2m8q).

namestring required

The user's full name (e.g. Jane Smith).

emailstring email required

The user's email address (e.g. jane@acme.example).

role'admin' | 'member' required

The user's access level.

status'active' | 'locked' | 'reset_requested' required

The user's account status.

mfa_enabledboolean

Whether multi-factor authentication is enabled for the user.

sso_linkedboolean

Whether the user is linked to the partner's IdP.

last_login_atstring date-time nullable

When the user last logged in — ISO 8601 UTC (e.g. 2026-06-01T09:30:00Z). null if never.

created_atstring date-time nullable

When the user was created — ISO 8601 UTC (e.g. 2026-05-01T00:00:00Z).

updated_atstring date-time nullable

When the user was last updated — ISO 8601 UTC (e.g. 2026-05-15T00:00:00Z).

Changes

No recorded changes to this operation across all 1 revision of this API.