POST /sites/$site/categories/new

Create a new category.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1.1/sites/$site/categories/new
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
name (string) Name of the category
description (string) A description of the category
parent (int) 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

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
403 unauthorized User cannot access this private blog.
403 unauthorized User cannot access this restricted blog
404 unknown_taxonomy That taxonomy does not exist
404 unknown_taxonomy Unknown taxonomy
400 duplicate A taxonomy with that name already exists
403 unauthorized User cannot edit taxonomy
403 authorization_required An active access token must be used to manage taxonomies.
400 invalid_input Unknown data passed
400 invalid_input Invalid request input

Example

curl \
 -H 'authorization: Bearer YOUR_API_TOKEN' \
 --data-urlencode 'name=Puppies' \
 'https://public-api.wordpress.com/rest/v1/sites/82974409/categories/new/'
<?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 (
        'name' => 'Puppies',
      )),
  ),
);

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

Response

{
    "ID": 28916,
    "name": "Puppies",
    "slug": "puppies",
    "description": "",
    "post_count": 0,
    "parent": 0,
    "meta": {
        "links": {
            "self": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/categories\/slug:puppies",
            "help": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409\/categories\/slug:puppies\/help",
            "site": "https:\/\/public-api.wordpress.com\/rest\/v1\/sites\/82974409"
        }
    }
}