Delete User REST Endpoint

Former Member — Fri, 13 May 2022 19:38:25 GMT

Current Revision posted to API Documentation by Former Member on 05/13/2022 19:38:25

POST (Header:DELETE) api.ashx/v2/users/{id}.{json|xml}

DELETE a user by user id.

Scopes

Users › Modify User users.users.modify

Request Parameters

Name	Type	Description	Required
DeleteAllContent	bool	If DeleteAllContent is set to true, ReassignUserId and ReassignUsername are ignored. User's content and related content will be deleted. (For example, if user has authored a blog post, that post and all related comments, likes, bookmarks, etc will be removed.)	Optional
Id	int?	Either Id or Username is required.	Optional
MergeToReassignedUser	bool?	This options should only be used if the user being deleted was created mistakenly as a duplicate account of the existing user. If true, in addition to content being reassigned to the reassign user, all group memberships, profile data, security roles, conversations, subscriptions, notification settings and friendships will be merged. Cannot be merged with a system account.	Optional
ReassignedUserId	int?	Reassign the deleted user's content to the user with this Id. If not specified, content will be reassigned to the 'Former Member' account.	Optional
ReassignedUsername	string	Reassign the deleted user's content to the user with this username. If not specified, content will be reassigned to the 'Former Member' account.	Optional
Username	string	Either Id or Username is required.	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.del({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/users/{id}.json',
	data: { 
		'id': '6'
	}
}).then(function(response) {
	// use response
});

Example Responses

JSON

{
  "Info": [
    "string",
    "string"
  ],
  "Warnings": [
    "string",
    "string"
  ],
  "Errors": [
    "string",
    "string"
  ]
}

XML

<?xml version="1.0" encoding="utf-16"?>
<Response>
  <Info>
    <Message>string</Message>
    <Message>string</Message>
  </Info>
  <Warnings>
    <Message>string</Message>
    <Message>string</Message>
  </Warnings>
  <Errors>
    <Message>string</Message>
    <Message>string</Message>
  </Errors>
</Response>

POST (Header:DELETE) api.ashx/v2/users/{username}.{json|xml}

DELETE a user by username.