Disconnect a mailbox
POST
/{provider}/accounts/disconnect
const url = 'https://api.clearance.rest/emails/gmail/accounts/disconnect';const options = { method: 'POST', headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'}, body: '{"email":"user@gmail.com"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.clearance.rest/emails/gmail/accounts/disconnect \ --header 'Content-Type: application/json' \ --header 'X-API-Key: <X-API-Key>' \ --data '{ "email": "user@gmail.com" }'Stops the provider-side watch or subscription (best effort: if access was already revoked, that is ignored) and deletes the connection.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”provider
required
string
Mail provider.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
email
required
string format: email
Example
{ "email": "user@gmail.com"}Responses
Section titled “Responses”Disconnected.
Media typeapplication/json
object
success
required
boolean
Example
{ "success": true}Invalid JSON body, or email is missing.
Media typeapplication/json
Error envelope returned with a non-2xx status.
object
success
required
boolean
error
required
Human-readable error message.
string
Example
{ "success": false, "error": "email zorunludur"}The X-API-Key header is missing or invalid.
Media typeapplication/json
Error envelope returned with a non-2xx status.
object
success
required
boolean
error
required
Human-readable error message.
string
Example
{ "success": false, "error": "geçersiz API anahtarı"}No such mailbox is connected to this project.
Media typeapplication/json
Error envelope returned with a non-2xx status.
object
success
required
boolean
error
required
Human-readable error message.
string
Example
{ "success": false, "error": "hesap bulunamadı"}