POST /me/preferences/

Update the current user's preferences.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1.1/me/preferences/
Requires authentication? No

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
calypso_preferences (object) Set the preferences associated with a user's WordPress.com Calypso experience.

Response Parameters

Parameter Type Description
calypso_preferences (object) Get the preferences associated with a user's WordPress.com Calypso experience.

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
400 invalid_input The calypso_preferences setting must be valid JSON.
400 invalid_input No preferences were provided for the endpoint to set.
403 unallowed_setting The setting key provided cannot be changed using this endpoint.
400 invalid_input The setting key provided is unknown.
403 authorization_required An active access token must be used to query information about the current user.

Example

curl ''
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'',
	false,
	$context
);
$response = json_decode( $response );
?>