Skip to main content
PATCH
Update the caller's mailbox connection

Authorizations

Authorization
string
header
required

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

Body

application/json
folder_ids
string[]
interval_minutes
integer
paused
boolean
sync_now
boolean

Poll the mailbox now instead of at the next interval. This also advances a filing's history import. A paused mailbox stays paused.

Response

Success

connected
boolean

True when the organisation's Microsoft 365 tenant has not approved the Mail app yet

folder_ids
string[]

Mail folders being synced

state
string

For example active, paused or needs_attention

attention
object
interval_minutes
integer
last_sync_at
string<date-time>
connected_at
string<date-time>