Skip to main content

updateUserStatus()

updateUserStatus(userId: string, status: string): Promise<UserSimpleResponse>

Defined in: packages/core/src/index.ts:583

Update a user's status (admin only)

Parameters

ParameterTypeDescription
userIdstringThe unique identifier of the user
statusstringNew status value ("active", "inactive", "suspended")

Returns

Promise<UserSimpleResponse>

Confirmation of status update

Throws

401 - Not authenticated

Throws

403 - Admin privileges required

Throws

404 - User not found

Example

import { updateUserStatus } from "@cpod/sdk";

// Deactivate a user
await updateUserStatus("user-123", "inactive");

// Reactivate a user
await updateUserStatus("user-123", "active");