Update User Status | PaymentKit

curl -X PATCH https://app.paymentkit.com/api/admin/users/user_id/status \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "is_active": false,
  "reason": "User requested deactivation due to extended leave"
}'

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "email": "jane.doe@example.com",
  "name": "Jane Doe",
  "clerk_user_id": "clerk_1234567890abcdef",
  "is_active": false,
  "created_at": "2023-11-20T08:45:00Z",
  "updated_at": "2024-04-10T14:22:00Z",
  "last_login_at": "2024-04-09T16:30:00Z",
  "organizations": [
    {
      "organization_id": "org_9876543210fedcba",
      "organization_name": "Acme Corporation",
      "role": "Administrator",
      "joined_at": "2022-05-15T10:00:00Z"
    }
  ],
  "accounts": [
    {
      "account_id": "acc_123abc456def7890",
      "account_name": "Acme Corp Main Account",
      "organization_id": "org_9876543210fedcba",
      "organization_name": "Acme Corporation",
      "role": "Account Manager",
      "joined_at": "2022-05-20T09:30:00Z"
    }
  ]
}

Activate or deactivate a user with a required reason.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

user_idstringRequired

Request

This endpoint expects an object.

is_activebooleanRequired

reasonstringRequired

Response

Successful Response

idstring

emailstring

namestring

clerk_user_idstring

is_activeboolean

created_atdatetime

updated_atdatetime

last_login_atdatetime or null

organizationslist of objects

accountslist of objects

Errors

422

Unprocessable Entity Error