key.delete
Description
Delete a single key object. Please see Deleting Objects for an overview of how the delete method works.
Parameters
key id
An integer representing the unique id of the key to delete. You may also pass a json object with a field of id to identify the key you wish to delete.
Response
Delete returns null on success.
Examples
A Sample JSON-RPC Key Delete Request
{
"method": "key.delete",
"params": [339],
"id": 1
}The JSON-RPC Response
{
"result": true,
"error": null,
"id": 1
}Permissions Required
The user who owns the key used to authenticate the key.delete call must be a member of one of the following roles
- Administrator
- Program Manager
- Community Manager
See authentication.
Errors
In addition to the standard json-rpc errors and authentication errors, key.delete may also return these errors:
| 500 | 2003 | Delete Failed | The object could not be deleted. This is the error message of last resort for object deletions and usually indicates a systems integration failure, invalid internal data, or a transient issue. These errors are logged by Mashery. |