> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snappy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete API key

> Use this endpoint to permanently delete an existing API key by its ID. Use this when an owner or tools admin needs to revoke a key - for rotation, compromise response, or cleanup.

###### Required fields
- `apiKeyId` - the API key identifier, passed as a path parameter (24-character hex)

###### Optional headers
- `Snappy-Account-Id` - optional account scoping
- `Snappy-Company-Id` - required for multi-company users to select the target Company

###### Behavior Notes
- **Deletion is immediate and permanent.** Once deleted, any application using this key will receive `401 Unauthorized` on its next request. Update your applications to use a replacement key *before* deleting the old one.
- Returns `204 No Content` on success - no response body.

#### Permissions
Authenticated via `Authorization: Bearer <dashboard user JWT>`. Only Company owners and tools admins have access.



## OpenAPI

````yaml delete /v3/authentication/api-keys/{apiKeyId}
openapi: 3.0.3
info:
  title: Snappy Public API v3
  version: 3.0.0
  contact:
    name: Snappy Support
    email: info@snappy.com
  description: >-
    Welcome to the Snappy API reference documentation!

    You can use this API to integrate with Snappy and spread smiles to your
    employees/clients/customers and much more.

    So let's get started!
servers:
  - url: https://api.snappy.com/public-api
    description: Base API URL
  - url: https://mtls-api.snappy.com/public-api
    description: >-
      ## mTLS URL

      You can also use mTLS to enhance your API security. To get your specific
      certificates please contact our support.

      Once you configure the certificated correctly, you need to also update
      endpoints to use the following secure api base URL:
security: []
tags:
  - name: Products
    description: >-
      Use these endpoints to retrieve products and tags for building catalog and
      browse experiences in your UI.
  - name: Collections
    description: >-
      Use these endpoints to retrieve products within curated collections for
      marketplace and browse experiences.
  - name: Variants
    description: >-
      Use these endpoints to retrieve variants, variant pricing, and country
      availability for orderable product SKUs.
  - name: Billing Methods
    description: >-
      A **Billing Method** is the funding source attached to an **Account** -
      for example, a Purchase Order (PO), Invoice, Prepay deposit, or Credit
      Card. Use these endpoints to retrieve billing method details such as
      remaining balance, status, and expiration.
  - name: Accounts
    description: >-
      An **Account** is a sub-entity within a **Company**, used to organize
      campaigns and gift sends. Use these endpoints to list, retrieve, and
      create accounts.
  - name: API Keys
    description: >-
      Use these endpoints to manage API keys for programmatic access. Key
      management requires company owner privileges.
  - name: Orders
    description: >-
      Use these endpoints to place, retrieve, cancel, and validate orders and
      shipping addresses.
paths:
  /v3/authentication/api-keys/{apiKeyId}:
    delete:
      tags:
        - Api_keys
      summary: Delete API key
      description: >-
        Use this endpoint to permanently delete an existing API key by its ID.
        Use this when an owner or tools admin needs to revoke a key - for
        rotation, compromise response, or cleanup.


        ###### Required fields

        - `apiKeyId` - the API key identifier, passed as a path parameter
        (24-character hex)


        ###### Optional headers

        - `Snappy-Account-Id` - optional account scoping

        - `Snappy-Company-Id` - required for multi-company users to select the
        target Company


        ###### Behavior Notes

        - **Deletion is immediate and permanent.** Once deleted, any application
        using this key will receive `401 Unauthorized` on its next request.
        Update your applications to use a replacement key *before* deleting the
        old one.

        - Returns `204 No Content` on success - no response body.


        #### Permissions

        Authenticated via `Authorization: Bearer <dashboard user JWT>`. Only
        Company owners and tools admins have access.
      parameters:
        - schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
            description: The API key id.
            example: 4a7f2b9C1E3d8f0A9B6c4D2e
          required: true
          description: The API key id.
          name: apiKeyId
          in: path
        - schema:
            type: string
            description: Optional account identifier for swag validation/filtering.
            example: acc123456
          required: false
          description: Optional account identifier for swag validation/filtering.
          name: snappy-account-id
          in: header
        - schema:
            type: string
            description: Optional company identifier for swag validation/filtering.
            example: cmp123456
          required: false
          description: Optional company identifier for swag validation/filtering.
          name: snappy-company-id
          in: header
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request - Invalid parameters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
        '403':
          description: Forbidden - Owner privileges required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
        '404':
          description: Not Found - API key not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV3'
      security:
        - BearerTokenAuthentication: []
        - ApiKeyAuthentication: []
components:
  schemas:
    ErrorResponseV3:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message.
          example: Product not found.
        errorCode:
          type: string
          description: Structured error code.
          example: 404_PROD_001
        errors:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
                example: Product with id 'q1w2e3r4t5' was not found
              path:
                type: string
                description: Dot-separated path to the field that caused the error.
                example: pathParameters.productId
              errorCode:
                type: string
                example: 404_PROD_001
            required:
              - message
              - path
          description: Optional field-level error details.
      required:
        - message
        - errorCode
      description: Standard v3 error envelope.
  securitySchemes:
    BearerTokenAuthentication:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        ## User Bearer Authentication


        Use a dashboard user JWT in the `Authorization` header when managing API
        keys from the Snappy dashboard:

        ```

        Authorization: Bearer YOUR_JWT

        ```


        For multi-company users, also pass `Snappy-Company-Id` to select the
        target company.
    ApiKeyAuthentication:
      type: apiKey
      in: header
      name: X-Api-Key
      description: |-
        ## Company Level Authentication

        Include your API key in the `X-Api-Key` header for every request:
        ```
        X-Api-Key: YOUR_API_KEY
        ```

````