Remove account
Stop processing and clear the account's cache. Pass revoke=true to also attempt revocation of the upstream OAuth2 grant at the provider before the account is removed.<br/><br/>Removes the account, its credentials, its cached data and any messages still queued for delivery. Webhook events generated before the deletion are never delivered afterwards and are discarded once the queue reaches them. Records of deliveries that had already failed permanently are not removed here; they expire on the queue retention window, seven days by default.
Request
- Base URL: https://your-emailengine-host
- URL: https://your-emailengine-host/v1/account/{account}
- Auth: HTTP bearer
Path parameters
Unique identifier for the email account
Query parameters
Revoke the upstream OAuth2 grant at the provider before deleting the account
Headers
Request timeout in milliseconds. Raises the command timeout above the EENGINE_TIMEOUT default for a long-running request; a value below the default has no effect
Response
Returns a deletion marker. The account stops syncing immediately; stored data is removed in the background.
Example response
{
"account": "user123"
}Changes
No recorded changes to this operation across all 1 revision of this API.