Email & PEC

Sync a mailbox now

Triggers an immediate IMAP poll of one mailbox instead of waiting for the next scheduled one. Returns right away with status: "queued" — the sync itself runs in the background, so call email_list_accounts a little later to see last_synced_at move. Calling it again while one is already queued does not queue a second one.

Examples

  • Check that mailbox for new mail now POST /api/v1/rest/email/accounts/22222222-3333-4444-8555-666666666666/sync
post/api/v1/rest/email/accounts/{id}/sync

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/email/accounts/{id}/sync
  • Auth: HTTP bearer

Path parameters

idstring uuid required

From email_list_accounts.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

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