POST/users/{userId}/suspend

Suspends an active member.

Note

  • The super admin cannot be suspended.
  • Only an active member whose account status is "In use" can be suspended.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

user
directory

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/suspend

Path Parameters

ParameterTypeDescription
userId string 

Member ID
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 204

No Content

HTTP 400

Bad Request

HTTP 404

Not Found