Skip to Content
API ReferenceUsersUpdate User Status

Update User Status

Set a user’s status to active or inactive. Inactive users cannot access the platform.

Endpoint

PATCH /api/v1/partner/users/:user_id/status

Path Parameters

ParameterTypeRequiredDescription
user_idUUIDYesThe user’s unique identifier

Request Body

FieldTypeRequiredDescription
statusstringYesMust be active or inactive

Response

Success 200 OK

{ "success": true, "message": "User status updated successfully", "data": { "user_id": "550e8400-e29b-41d4-a716-446655440000", "status": "active", "updated_at": "2026-02-15T10:45:22.123Z" } }

Errors

StatusErrorDescription
400Invalid user IDuser_id is not a valid UUID
400Invalid statusMust be active or inactive
401UnauthorizedInvalid or missing API key
404User not foundUser doesn’t exist under your account

Try It

PATCH/api/v1/partner/users/{user_id}/statusUpdate user status
{user_id}