POST /sites/$site/tags/slug:$tag

Edit a Tag

Resource URL

Type URL and Format
POST https://public-api.wordpress.com/rest/v1/sites/$site/tags/slug:$tag

Method Parameters

Parameter Type Description
$site (int|string) The site ID, The site domain
$tag (string) The tag slug

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 enviroments (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
callback (string) An optional JSONP callback function.

Request Parameters

Parameter Type Description
name (string) Name of the tag
description (string) A description of the tag

Response Parameters

Parameter Type Description
ID (int) The tag ID.
name (string) The name of the tag.
slug (string) The slug of the tag.
description (string) The description of the tag.
post_count (int) The number of posts using this t.
meta (object) Meta data

Example

cURL

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 --data-urlencode 'description=Kitties are awesome!' \
 'https://public-api.wordpress.com/rest/v1/sites/30434183/tags/slug:testing-tag'

PHP

<?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 (
        'description' => 'Kitties are awesome!',
      )
    ),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
  'https://public-api.wordpress.com/rest/v1/sites/30434183/tags/slug:testing-tag',
  false,
  $context
);
$response = json_decode( $response );

?>

Response Body

{
	"name": "testing tag",
	"slug": "testing-tag",
	"description": "Kitties are awesome!",
	"post_count": 0,
	"meta": {
		"links": {
			"self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/30434183\/tags\/testing-tag",
			"help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/30434183\/tags\/testing-tag\/help",
			"site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/30434183"
		}
	}
}