Skip to main content
POST
Sync email messages from provider

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
accountId
string
required

EmailAccount _id to sync.

maxResults
number

Cap on messages fetched per sync run.

lookbackDays
number | null

Optional override for the sync window; null = use account default.

Response

Sync started or status returned

Returned immediately after POST /api/email/messages/sync kicks off the historical sync. Poll GET /api/email/messages/sync/status for progress.

status
enum<string>
required
Available options:
running