Completely remove a user from the system (Not SCIM compliant)

Request

Permanently remove a User and their details from the authenticated program. A non-existent user, or a user that's already been forgotten, will return a 202.

If the user record belongs to multiple programs (communities), only the user record for the authenticated program will be removed.

Security

oauth2_as_a_server(Required scopes: users.write) or oauth2_as_a_user(Required scopes: users.write)

Path

user_idstringrequired

ID of the user to forget

curl -i -X POST \
  'https://partner.socialchorus.com/v2/Users/{user_id}/forget' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json

dataobject or nullrequired

Always null for this endpoint; the user is removed asynchronously.

Example:null

Response

{
  "data": null
}