Skip to main content
DELETE
/
v1
/
api_keys
/
{id}
JavaScript
import Charcoal from '@charcoalhq/sdk';

const client = new Charcoal({
  apiKey: process.env['CHARCOAL_API_KEY'], // This is the default and can be omitted
});

const apiKey = await client.apiKeys.delete('id');

console.log(apiKey.success);
{
  "success": true
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

API key identifier (e.g. akey_CjXuYOtW).

Response

Successful response

success
boolean
required