POST /sites/$site/comments/status

Update multiple comment's status.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1/sites/$site/comments/status
Requires authentication? Yes

Method Parameters

Parameter Type Description
$site (int|string) Site ID or domain

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
comment_ids (array|string) An array, or comma-separated list, of Comment IDs to update.
status (string) The new status value. Allowed values: approved, unapproved, spam, trash

Response Parameters

Parameter Type Description
results (array) An array of updated Comment IDs.

Resource Errors

This endpoint does not return any errors.

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 --data-urlencode 'comment_ids=Array' \
 --data-urlencode 'status=approved' \
 'https://public-api.wordpress.com/rest/v1/sites/82974409/comments/status'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
      1 => 'Content-Type: application/x-www-form-urlencoded',
    ),
    'content' => 
     http_build_query(  array (
        'comment_ids' => 
        array (
          0 => 881,
          1 => 882,
        ),
        'status' => 'approved',
      )),
  ),
);

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