API Keys
Delete API key
Use this endpoint to permanently delete an existing API key by its ID. Use this when rotating keys, removing a compromised key, or cleaning up unused keys.
Required fields
apiKeyId- the API key identifier, passed as a path parameter (24-character hex)
Optional parameters
Request-Sourceheader - source of the request
Behavior Notes
- Deletion is immediate and permanent. Once deleted, any application using this key will receive
401 Unauthorizedon its next request. Update your applications to use a replacement key before deleting the old one. - Returns
204 No Contenton success - no response body.
Permissions
- Requires:
apiKeys:delete
DELETE
Delete API key
Authorizations
Company Level Authentication
Company level authentication provides access to all resources under your company, including accounts, campaigns, gifts, and recipients.
Getting Your API Key
- Create an API Key: Use the
POST /v2/authentication/apiKeysendpoint to generate a new API key - Set Expiration: Choose from 30, 60, 90, or 180 days (default: 90 days)
- Optional mTLS: Enable mutual TLS for enhanced security
- Name Your Key: Provide a descriptive name for easy identification
Using Your API Key
Include your API key in the X-Api-Key header for every request:
API Key Management
- Maximum Keys: Up to 3 active API keys per company
- Rotation: Delete old keys before creating new ones when at the limit
- Security: Keys are hashed and cannot be retrieved after creation
Enhanced Security (mTLS)
For production environments, enable mutual TLS authentication:
- Set
enforceMtls: truewhen creating the API key - Contact support to obtain your client certificates
- Use the mTLS endpoint:
https://mtls-api.snappy.com/public-api
Headers
Source of the request
Available options:
api_native, api_zapier, api_salesforce, api_ftp, api_make Example:
"api_native"
Path Parameters
The API key id
Pattern:
^[a-fA-F0-9]{24}$Example:
"4a7f2b9C1E3d8f0A9B6c4D2e"
Response
No Content
Last modified on June 17, 2026