POST/actor_tokens/{actor_token_id}/revoke

Revoke an actor token

Revokes a pending actor token, changing its status to revoked. Use actor_token_id to identify the token; the response includes its resulting status and associated actor and user details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
actor_token_idstringrequired
The ID of the actor token to revoke.

3 status codes
200Returns the actor token object, including its status, user ID, actor details, and creation and update timestamps.
objectstringrequired
Allowed:actor_token
idstringrequired
statusstringrequired
Allowed:pendingacceptedrevoked
user_idstringrequired
actorobjectrequired
tokenstringoptional
urlstringoptional
created_atintegerrequired
Unix timestamp of creation.
updated_atintegerrequired
Unix timestamp of last update.
400Returned when the revocation request is not successful.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
404Returned when the actor token does not exist.
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned when the revocation request is not successful. A 404 is returned when actor_token_id does not identify an existing actor token.