API keys, webhooks and installsRevoke an API key

API keys, webhooks and installs

Revoke an API key

DEL/v1/api-keys/{id}

Stops an API key from working, at once and for good.

Any request with the key fails with unauthenticated from now on. A revoked key cannot be restored: create a new one. Revoking a key issued to a store install stops that store from creating documents; unlink the install instead if you mean to disconnect the store.

The body must contain "confirm": true. The revocation is audited.

Needs confirmation

This action is destructive or moves money. Send "confirm": true in the body; without it you get 428 confirmation_required and a preview of what would happen. See Drafts and confirmations.

Permission
integrations.manage
Type
Destructive or money-moving. Needs "confirm": true (or a confirmation in the app).
Auth
API key, MCP token or signed-in session
Capability
revoke_api_key
CLI
freeinvoiceautomation key revoke
Available
At launch, 1 January 2027
revoke_api_key
curl --request DELETE \
  --url https://api.freeinvoiceautomation.com/v1/api-keys/<id> \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Idempotency-Key: <unique-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "confirm": true
}'
No content

Authorizations

Authorizationstringrequired
Bearer <api-key>. An API key from Settings > API keys, or an MCP token. See Authentication.

Headers

Idempotency-Keystring
Any unique string up to 255 characters. Required for API-key and MCP calls that create something; optional otherwise. See Idempotency.

Path Parameters

idstring<uuid>required
Id of the API key.

Body

application/json
confirmbooleanrequired
Must be true. Without it the call changes nothing and returns 428 confirmation_required with a preview of what would happen. See Drafts and confirmations.

Errors

Plus the common errors every call can return. See Errors.