POST /me/keyring-connections/$keyring_connection_ID/delete

Delete the Keyring connection (and associated token) with the provided ID. Also deletes all associated publicize connections.

Resource Information

   
Method POST
URL https://public-api.wordpress.com/rest/v1.1/me/keyring-connections/$keyring_connection_ID/delete
Requires authentication? Yes

Method Parameters

Query Parameters

Response Parameters

Resource Errors

These are the possible errors returned by this endpoint.

HTTP Code Error Identifier Error Message
403 authorization_required You do not have permission to access this Keyring connection.
400 invalid_input Please provide a valid numeric Keyring connection ID
403 authorization_required Access token does not have the required scope
400 deletion_error This connection could not be deleted.
403 authorization_required An active access connection must be used to access keyring connections.
403 authorization_required This user is not authorized to access keyring connections on 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' \
 'https://public-api.wordpress.com/rest/v1.1/me/keyring-connections/1234/delete'
<?php
$options  = array (
  'http' => 
  array (
    'ignore_errors' => true,
    'method' => 'POST',
    'header' => 
    array (
      0 => 'authorization: Bearer YOUR_API_TOKEN',
    ),
  ),
);

$context  = stream_context_create( $options );
$response = file_get_contents(
	'https://public-api.wordpress.com/rest/v1.1/me/keyring-connections/1234/delete',
	false,
	$context
);
$response = json_decode( $response );
?>

Response

{
    "ID": 1234567,
    "site_ID": 3584907,
    "user_ID": 12345678,
    "keyring_connection_ID": 1234567,
    "keyring_connection_user_ID": 12345678,
    "shared": false,
    "service": "twitter",
    "label": "Twitter",
    "issued": "2014-08-2302:49:47",
    "expires": "0000-00-0000:00:00",
    "external_ID": "15919116",
    "external_name": "Automattic",
    "external_display": "@automattic",
    "external_profile_picture": "https:\/\/pbs.twimg.com\/profile_images\/453860857923923968\/Rg_FuLjK_400x400.png",
    "external_profile_URL": "http:\/\/twitter.com\/automattic",
    "external_follower_count": 24103,
    "status": "ok",
    "refresh_URL": "https:\/\/public-api.wordpress.com\/connect\/?action=request&kr_nonce=xxxxxxxxxx&nonce=xxxxxxxxxx&refresh=1&for=connect&service=twitter&kr_blog_nonce=xxxxxxxxxx&magic=keyring&blog=3584907",
    "meta": {
        "links": {
            "self": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/3584907\/publicize-connections\/1234567",
            "help": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/3584907\/publicize-connections\/1234567\/help",
            "site": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/sites\/3584907",
            "service": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/meta\/external-services\/twitter",
            "keyring-connection": "https:\/\/public-api.wordpress.com\/rest\/v1.1\/me\/keyring-connections\/1234567"
        }
    }
}