Resource Information
Method
POST
URL
https://public-api.wordpress.com/rest/v1.1/sites/$site/sharing-buttons
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
sharing_buttons
(array)
An array of sharing button objects
Response Parameters
Parameter
Type
Description
success
(bool)
Confirmation that all sharing buttons were updated as specified
updated
(array)
An array of updated sharing buttons
Resource Errors
These are the possible errors returned by this endpoint.
HTTP Code
Error Identifier
Error Message
400
missing_jetpack_module
The Sharing module must be activated in order to use this endpoint
400
invalid_request
The URL field is required
400
invalid_request
The icon field is required
404
not_found
The specified sharing button was not found
403
forbidden
You do not have the capability to manage sharing buttons for this site
403
unauthorized
User cannot access this private blog.
403
unauthorized
User cannot access this restricted blog
Example
curl \
-H 'authorization: Bearer YOUR_API_TOKEN' \
--data-urlencode 'sharing_buttons=Array' \
'https://public-api.wordpress.com/rest/v1/sites/30434183/sharing-buttons'
<?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 (
'sharing_buttons' =>
array (
0 =>
array (
'ID' => 'facebook',
'visibility' => 'hidden',
),
),
)),
),
);
$context = stream_context_create( $options );
$response = file_get_contents(
'https://public-api.wordpress.com/rest/v1/sites/30434183/sharing-buttons',
false,
$context
);
$response = json_decode( $response );
?>
Response
{
"success": true,
"updated": [
{
"ID": "facebook",
"name": "Facebook",
"shortname": "facebook",
"custom": false,
"enabled": true,
"visibility": "hidden",
"genericon": "\f204"
}
]
}