KLklaviyo
Beta APIs

Update API Key

Changed on 
        > 🚧 This endpoint is in beta and subject to change.
        >
        > A beta revision header (2026-10-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our [versioning and deprecation policy](https://developers.klaviyo.com/en/docs/api_versioning_and_deprecation_policy) for more information.

Update the label or enable/disable the key.<br><br>Rate limits:<br>Burst: 1/s<br>Steady: 15/m

Scopes: credentials:write

OpenAPI Spec

patch/api/api-keys/{id}

Request

Path parameters

idstring required

Identifier for the key to update.

Example:01HQXYZ

Query parameters

additional-fields[api-key]string[]

Request additional fields not included by default in the response. Supported values: 'redacted_key'

fields[api-key]string[]

For more information please visit https://developers.klaviyo.com/en/v2026-10-15.pre/reference/api-overview#sparse-fieldsets

Headers

revisionstring required

API endpoint revision (format: YYYY-MM-DD[.suffix])

Request body

Example request

{
  "data": {
    "id": "01HQXYZ",
    "attributes": {
      "name": "prod-webhook-handler",
      "status": "disabled"
    }
  }
}

Response

Success

Example response

{
  "data": {
    "id": "01HQXYZ",
    "attributes": {
      "name": "prod-webhook-handler",
      "status": "active",
      "scopes": [
        "profiles:read",
        "events:write"
      ],
      "created": "2022-11-08T00:00:00+00:00",
      "redacted_key": "pk_****abcd"
    }
  }
}

Changes

  • 67d4dca13074Revision changes
    • warning

      added the new experiments:read enum value to the /// response property for the response status

  • e06c9e59da3bRevision changes
    • warning

      added the new locations:read enum value to the /// response property for the response status

    • warning

      added the new locations:write enum value to the /// response property for the response status

    • warning

      added the new messages:read enum value to the /// response property for the response status

    • warning

      added the new messages:write enum value to the /// response property for the response status