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) |
|
http_envelope | (bool) |
|
pretty | (bool) |
|
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 | 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 |
400 | missing_jetpack_module | The Sharing module must be activated in order to use this endpoint |
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
1 2 3 4 | curl \ -H 'authorization: Bearer YOUR_API_TOKEN' \ --data-urlencode 'sharing_buttons=Array' \ |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 | <?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 ( false, $context ); $response = json_decode( $response ); ?> |
Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | { "success" : true , "updated" : [ { "ID" : "facebook" , "name" : "Facebook" , "shortname" : "facebook" , "custom" : false , "enabled" : true , "visibility" : "hidden" , "genericon" : "\f204" } ] } |