MImixedbread
integrations

Sync a connected account

Changed on

Queue a sync of the selected resources, or of the given subset where the provider supports it.

With sync_all the account's entire contents are selected and synced, and new resources keep being picked up on their own; the listing then reports sync_all until an explicit selection replaces it.

post/v1/integrations/installations/{installation_id}/sync

Request

  • Base URL
    https://api.mixedbread.com
  • URL
    https://api.mixedbread.com/v1/integrations/installations/{installation_id}/sync
  • Auth
    HTTP bearer

Path parameters

installation_idstring uuid required

Installation ID, as returned when the account connected

Request body

resource_idsstring[] nullable

Selected resource IDs to sync; defaults to every selected resource. Providers that sync the whole installation at once ignore this and sync everything selected.

sync_allboolean

Sync everything the account can see and keep syncing new resources as they appear: every mail outside spam, trash and drafts, the whole Drive, every note, or every conversation. Replaces the selection; a later explicit selection turns the mode off again.

Response

Queued and skipped resources

Changes

  • 957bf8ec8df8Revision changes
    • info

      added the optional property / to the response with the status

  • 1a6549d3e64dRevision changes
    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status