Suspend User Account

/services/v2/users/gdpr/[user-id]/suspend.json

- URL Params
No params needed; the user ID is already a path param.

- Data Params
No data params

🚧

For Permissions, Requirements, and More Detailed Information:

Reference the GDPR Plugin Docs in the Non-Reference portion of the documentation.

Sample Request

A POST Suspend User Account request for a user named suspendabletestuser (userId:111) sent to https://apidocs.cloud.answerhub.com using a human-readable Username/Password (answerhub/test123) would look like this:

curl 
-u answerhub:test123
-H "Accept:application/json" 
-H "Content-Type:application/json"
-X POST "https://apidocs.cloud.answerhub.com/services/v2/users/gdpr/111/suspend.json"

Expected Responses

- Success Response:
Code: 200

- Error Response:
Code: 422 UNPROCESSABLE ENTRY
Content: { error: "Invalid User Id" }

Sample Response

Successful Response:

  • HTTP Status 200 - OK
{
    "message": "User 111 suspended successfully"
}

Click to see the user profile for suspendabletestuser (userId:111)

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!