POST /sites/$site/categories/slug:$category

Edit a Category

Resource URL

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

Method Parameters

Parameter Type Description
$site (int|string) The site ID, The site domain
$category (string) The category 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 category
description (string) A description of the category
parent (id) ID of the parent category

Response Parameters

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

Example

cURL

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 --data-urlencode 'description=Puppies are great!' \
 'https://public-api.wordpress.com/rest/v1/sites/30434183/categories/slug:testing-category'

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' => 'Puppies are great!',
      )
    ),
  ),
);

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

?>

Response Body

{
	"name": "testing category",
	"slug": "testing-category",
	"description": "Puppies are great!",
	"post_count": 0,
	"parent": 0,
	"meta": {
		"links": {
			"self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/30434183\/categories\/testing-category",
			"help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/30434183\/categories\/testing-category\/help",
			"site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/30434183"
		}
	}
}