Skip to main content
PUT
/
users
/
{user_id}
/
deactivate
Deactivate user
curl --request PUT \
  --url https://api.pcxpay.com/v1/users/{user_id}/deactivate \
  --header 'Content-Type: application/json' \
  --data '
{
  "updated_by": "<string>",
  "reason": "<string>"
}
'
{
  "message": "User deactivated successfully",
  "user": {
    "user_id": "<string>",
    "email": "jsmith@example.com",
    "fname": "<string>",
    "lname": "<string>",
    "date_of_birth": "<string>",
    "cognito_username": "<string>",
    "bridge_customer_id": "<string>",
    "kyc_submitted_at": "<string>",
    "kyc_approved_at": "<string>",
    "kyc_failure_reason": "<string>",
    "role": "admin",
    "status": "active",
    "type": "internal-admin",
    "created_by": "<string>",
    "org_id": "<string>",
    "org_ids": [
      "<string>"
    ],
    "phone_number": "<string>",
    "address": "<string>",
    "country": "<string>",
    "id_type": "passport",
    "id_number": "<string>",
    "additional_id_type": "passport",
    "additional_id_number": "<string>",
    "kyc_session_id": "<string>",
    "kyc_status": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>"
  },
  "reason": "<string>"
}

Path Parameters

user_id
string
required

Body

application/json
updated_by
string
required
reason
string

Response

User deactivated

message
string
Example:

"User deactivated successfully"

user
object
reason
string | null