Revoke a token by ID
Revokes a single storefront API token identified by its jti. You do not need the token’s JWT string to revoke it - only the jti returned by the List tokens endpoint.
You can only revoke tokens that your own API account issued through this token family. Supplying a jti issued by a different API account, or belonging to a different token family, returns 404 Not Found.
Each store can hold a limited number of revoked tokens that have not yet expired. Once that limit is reached, this endpoint returns 422 Unprocessable Entity until some revoked tokens expire. The revoke-all endpoint is not subject to this limit.
Revocation can take up to approximately 60 seconds to fully propagate because revoked identifiers are held in a short-lived cache, so a revoked token may briefly continue to authenticate.
Required Scopes
ManageStorefront API Tokens
Authentication
OAuth scopes
Authentication header
Further reading
For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.
For more about BigCommerce OAuth scopes, see our Guide to API Accounts.
Path parameters
Unique identifier (the JWT jti claim) of the token to revoke.
Headers
The MIME type of the response body.