Skip to main content
DELETE
Revoke API Key
Use this endpoint to immediately prevent it from being used for authentication with your Rewards App.
Revoking an API key immediately prevents it from being used for authentication. Any services using this key will no longer be able to access your Rewards App. If Send Reward v2 is using this API key, it will stop working once the key is revoked, as the key becomes invalid.
Permanent Action. Once revoked, an API key cannot be reactivated. You will need to create a new API key if needed.

Configuration

Header Parameters

string
required
Client identifier (use “developer-dashboard” )
string
required
Bearer token for authenticationFormat: Bearer {JWT_TOKEN}

Path Parameters

string
required
Your Rewards App ID
string
required
The ID of the API key to revoke Get this ID from the “List API Keys” endpoint

Response Fields


Response Status Codes

Code Examples

What Happens After Revocation?

Before Revocation API Key Active

Key can be used for authentication

After Revocation API Key Revoked

Key can no longer authenticate

Try It Out

Ready to revoke an API key? Use our API playground on the right to test with your JWT token.