Resource Information
Method
POST
URL
https://public-api.wordpress.com/rest/v1.1/sites/$site/users/$user_id
Requires authentication?
Yes
Method Parameters
Parameter
Type
Description
$site
(int|string)
The site ID or domain.
$user_id
(int)
The user's 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.
Request Parameters
Parameter
Type
Description
ID
(int)
The ID of the user
login
(string)
The login username of the user
email
(string)
The email of the user
name
(string)
The name to display for the user
first_name
(string)
The first name of the user
last_name
(string)
The last name of the user
nice_name
(string)
The nice_name to display for the user
URL
(string)
The primary blog of the user
avatar_URL
(url)
Gravatar image URL
profile_URL
(url)
Gravatar Profile URL
site_ID
(int)
ID of the user's primary blog
roles
(array|string)
The role or roles of the user
Response Parameters
Parameter
Type
Description
ID
(int)
The ID of the user
login
(string)
The login username of the user
email
(string)
The email of the user
name
(string)
The name to display for the user
first_name
(string)
The first name of the user
last_name
(string)
The last name of the user
nice_name
(string)
The nice_name to display for the user
URL
(string)
The primary blog of the user
avatar_URL
(url)
Gravatar image URL
profile_URL
(url)
Gravatar Profile URL
site_ID
(int)
ID of the user's primary blog
roles
(array|string)
The role or roles of the user
Resource Errors
These are the possible errors returned by this endpoint.
HTTP Code
Error Identifier
Error Message
403
unauthorized_edit_owner
Current user can not edit blog owner
403
unauthorized_no_promote_cap
User cannot promote users for specified site
404
unknown_user
Unknown user
404
unknown_user_for_site
Unknown user for site
403
unauthorized
You cannot change your own role
403
unauthorized
User cannot access this private blog.
403
unauthorized
User cannot access this restricted blog
403
unauthorized
User cannot view users for specified site
Example
curl \
-H 'authorization: Bearer YOUR_API_TOKEN' \
--data-urlencode 'roles=Array' \
--data-urlencode 'first_name=Rocco' \
--data-urlencode 'last_name=Tripaldi' \
'https://public-api.wordpress.com/rest/v1/sites/30434183/user/23'
<?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 (
'roles' =>
array (
0 =>
array (
0 => 'administrator',
),
),
'first_name' => 'Rocco',
'last_name' => 'Tripaldi',
)),
),
);
$context = stream_context_create( $options );
$response = file_get_contents(
'https://public-api.wordpress.com/rest/v1/sites/30434183/user/23',
false,
$context
);
$response = json_decode( $response );
?>
Response
{
"ID": 18342963,
"login": "binarysmash",
"email": false,
"name": "binarysmash",
"URL": "http:\/\/binarysmash.wordpress.com",
"avatar_URL": "http:\/\/0.gravatar.com\/avatar\/a178ebb1731d432338e6bb0158720fcc?s=96&d=identicon&r=G",
"profile_URL": "http:\/\/en.gravatar.com\/binarysmash",
"roles": [
"administrator"
]
}