POST /read/tags/$tag/mine/delete

Unsubscribe from a tag.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1.1/read/tags/$tag/mine/delete
Requires authentication? Yes

Method Parameters

Parameter Type Description
$tag (string) The name of the tag to unsubscribe from.

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
subscribed (bool) Is the user subscribed to the tag?

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
400 not_subscribed You are not subscribed to the specified tag.
400 already_subscribed You are already subscribed to the specified tag.
400 invalid_tag The TAG requested does not seem to be a valid tag.

Example

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

Response

{
    "subscribed": false
}