Revoke a token

View as Markdown
Revoke a token and mark the stored credentials for deletion. Call it the moment a customer withdraws consent, closes their account with you, or asks you to stop — and after any suspicion that the pair leaked. It is immediate and it is not reversible: no execution can use the token afterwards. - `204` — revoked. - `304` — it was already revoked. Nothing changed. - `404` — no such token for your application. Revoking a token does not touch executions already run with it, nor the records they produced. Those are deleted with [Delete an Execution](api:DELETE/executions/handler/v1/{execution_id}/delete). > This endpoint needs to be executed with an app secret, so should always be used in server side without exposing the secret to customers.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

token_idstringRequiredformat: "object-id"

The stored-credentials token, as the exchange returned it.

Response

204 No Content
Revoked. The token stops working immediately and the credentials it stood for are removed. Executions already run with it, and the records they produced, are untouched — those are deleted with the executions themselves. No body.

Errors

404
Not Found Error
422
Unprocessable Entity Error