Remove User

To remove a user, send a DELETE request with the endpoint and payload defined below. This is a soft delete, you will be able to restore these users if you wish. The user record must NOT be active in order to remove them. The user making this request either must have the ADMIN or MANAGE_PEOPLE permissions.

Parameters

name * are required parameter	data type	description
targetPath*	string	the path to the organization or tenant where the user record 'lives'
userId*	string

Return Value

On success, the API will return the following response with code 201.

{
  "data": null,
  "message": "Successfully removed the users",
}

Examples

bash

curl -X DELETE -H "Authentication: ZmFrZQ==" https://app.wombat.software/api/{targetPath}/user/{userId}"