Skip to content
SimpleCold

API docs

Get started

Enable or disable an API key

On this page

Disable a key to stop it working without losing it, for example during a security review. Enable it again when you are ready. Disabling is also how you retire a key: keys can't be deleted.

Steps

  1. Open API keys. Log in and go to simplecold.com/dashboard/api-keys.

    The API Keys table
  2. Find the key in the table.

  3. Flip its switch, or open the actions menu and choose Disable or Enable, then confirm.

    The enable and disable switch

What changes

Key stateRequests with the key
EnabledWork as normal.
DisabledFail with 401 API key is inactive.

The key's value doesn't change, so integrations work again as soon as you enable it. A disabled key can't be regenerated; enable it first.

Enable or disable an API key | SimpleCold API docs