POST /sites/$site/users/$user_ID/delete

Deletes or removes a user of a site.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1.1/sites/$site/users/$user_ID/delete
Requires authentication? Yes

Method Parameters

Parameter Type Description
$site (int|string) The site ID or domain.
$user_ID (int) The user's ID

Query Parameters

Parameter Type Description
context (string)
display:
(default) Formats the output as HTML for display. Shortcodes are parsed, paragraph tags are added, etc..
edit:
Formats the output for editing. Shortcodes are left unparsed, significant whitespace is kept, etc..
http_envelope (bool)
false:
(default)
true:
Some environments (like in-browser JavaScript or Flash) block or divert responses with a non-200 HTTP status code. Setting this parameter will force the HTTP status code to always be 200. The JSON response is wrapped in an "envelope" containing the "real" HTTP status code and headers.
pretty (bool)
false:
(default)
true:
Output pretty JSON
meta (string) Optional. Loads data from the endpoints found in the 'meta' part of the response. Comma-separated list. Example: meta=site,likes
fields (string) Optional. Returns specified fields only. Comma-separated list. Example: fields=ID,title
callback (string) An optional JSONP callback function.

Request Parameters

Parameter Type Description
reassign (int) An optional id of a user to reassign posts to.

Response Parameters

Parameter Type Description
success (bool) Was the deletion of user successful?

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
400 invalid_input User can not remove or delete self through this endpoint.
403 unauthorized User cannot delete users for specified site.
400 invalid_input Can not reassign posts to user being deleted.
400 invalid_input User specified in reassign argument is not a member of the specified site.
403 unauthorized User cannot remove users for specified site.
400 invalid_input A user does not exist with that ID.
400 invalid_input A valid user ID must be specified.
403 forbidden A site owner can not be removed through this endpoint.
400 invalid_input User is not a member of the specified site.
403 unauthorized User cannot access this private blog.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1/sites/82974409/users/1/delete'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
    ),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1/sites/82974409/users/1/delete',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "success": true
}