POST /sites/$site/comments/$comment_ID/delete

Resource Information

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

Method Parameters

Parameter	Type	Description
$site	(int|string)	Site ID or domain
$comment_ID	(int)	The comment 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.

Response Parameters

Parameter	Type	Description
ID	(int)	The comment ID.
post	(object)	A reference to the comment's post.
author	(object)	The author of the comment.
date	(iso 8601 datetime)	The comment's creation time.
URL	(url)	The full permalink URL to the comment.
short_URL	(url)	The wp.me short URL.
content	(html)	context dependent.
raw_content	(string)	Raw comment content.
status	(string)	approved: The comment has been approved. unapproved: The comment has been held for review in the moderation queue. spam: The comment has been marked as spam. trash: The comment is in the trash. deleted: The comment has been deleted permanently.
parent	(object|false)	A reference to the comment's parent, if it has one.
type	(string)	comment: The comment is a regular comment. trackback: The comment is a trackback. pingback: The comment is a pingback. review: The comment is a product review.
like_count	(int)	The number of likes for this comment.
i_like	(bool)	Does the current user like this comment?
meta	(object)	Meta data
can_moderate	(bool)	Whether current user can moderate the comment.
i_replied	(bool)	Has the current user replied to this comment?

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code	Error Identifier	Error Message
403	unauthorized	User cannot view post
403	unauthorized	User cannot access this private blog.
403	unauthorized	User cannot access this restricted blog
403	unauthorized	User cannot delete comment
403	trash_disabled	Cannot trash comment
403	authorization_required	An active access token must be used to comment.
403	unauthorized	Comments on this post are closed
403	unauthorized	Comments on drafts are not allowed
403	unauthorized	User cannot create comments
403	unauthorized	User cannot read unapproved comment

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 'https://public-api.wordpress.com/rest/v1/sites/82974409/comments/$comment_ID/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/comments/$comment_ID/delete',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "ID": 11076,
    "post": {
        "ID": 3,
        "title": "Hello World (Again)",
        "type": "post",
        "link": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/posts\/3"
    },
    "author": {
        "ID": 0,
        "login": "",
        "email": "",
        "name": "",
        "first_name": "",
        "last_name": "",
        "nice_name": "",
        "URL": "",
        "avatar_URL": "https:\/\/0.gravatar.com\/avatar\/?s=96&d=identicon&r=G",
        "profile_URL": "https:\/\/en.gravatar.com\/d41d8cd98f00b204e9800998ecf8427e",
        "ip_address": ""
    },
    "date": "2023-03-31T06:00:49+00:00",
    "URL": "https:\/\/apiexamples.wordpress.com\/2015\/01\/15\/hello-world\/comment-page-1\/#comment-11076",
    "short_URL": "https:\/\/wp.me\/p5C9qV-3%23comment-11076",
    "content": "<p>This is a test comment.<\/p>\n",
    "raw_content": "This is a test comment.",
    "status": "trash",
    "parent": false,
    "type": "comment",
    "like_count": 0,
    "i_like": false,
    "meta": {
        "links": {
            "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/comments\/11076",
            "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/comments\/11076\/help",
            "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409",
            "post": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/posts\/3",
            "replies": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/comments\/11076\/replies\/",
            "likes": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/comments\/11076\/likes\/"
        }
    },
    "can_moderate": true,
    "i_replied": false
}