Skip to content

Ask the vault to read a connected mailbox now, instead of waiting for the next scheduled read

POST
/meta/v1/connections/{id}/sync

Human only. Records a sync request and starts a background run; answers 202 at once, before anything is read. The run captures new mail, and a mailbox that has never synced starts with a backfill. Read connections.get for last_synced_at (when it finished) and last_error_code (why it did not). 404 for an unknown or disconnected connection; 409 connection_inactive when the connection needs a reconnect (reauth_required or suspended); 501 provider_not_configured when this deployment cannot sync.

id
required
string format: uuid

Success

object
requested_at
required

When the request was recorded. The mailbox is read by a background run that starts now; read connections.get for last_synced_at and last_error_code.

string