Revoke Authorization
POST/api/faire/instances/:integrationInstance/revoke
Revoke the stored Faire access token both at Faire (POST /api/external-api-oauth2/revoke) and locally on the integration instance.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
After revocation, is_authorized will be false and granted_scopes will be empty. The instance must be re-authorized via the OAuth flow before it can sync again.
Path Parameters:
integrationInstance- The ID of the integration instance
Auth: Requires Bearer token.
Errors:
422- Faire returned an error during revocation (e.g., already revoked, invalid token). The local token is still cleared.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.