Account

Request syncing

Immediately trigger account syncing for IMAP accounts<br/><br/>The request only schedules the work and returns before it finishes. Watch the account state, or the accountInitialized and authenticationError webhooks, for the result.

put/v1/account/{account}/sync

Request

  • Base URL: https://your-emailengine-host
  • URL: https://your-emailengine-host/v1/account/{account}/sync
  • Auth: HTTP bearer

Path parameters

accountstring required

Unique identifier for the email account

Example:user123

Headers

x-ee-timeoutinteger

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

Example:30000

Request body

syncboolean

Only sync if true

sincestring date-time

Outlook (MS Graph) accounts only, ignored for other account types. Look for messages received since this time that were never announced, instead of the usual recovery window of the last few hours. Messages announced before EmailEngine stopped remembering them (about six hours) are announced again with a new messageNew webhook. At most 30 days back.

Example request

{
  "since": "2026-10-02T13:00:00.000Z"
}

Response

Returns an acknowledgement. A full mailbox sync is scheduled and runs in the background.

syncboolean

Sync status

Changes

No recorded changes to this operation across all 1 revision of this API.