Mixedbread

Sync Installation

Queue a sync of the selected resources, of a subset, or of everything the account can see with sync_all.

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

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.

Authorization

ApiKeyAuth
headerAuthorizationBearer <token>

Api key to access Mixedbreads API

Path Parameters

installation_id*Installation Id

Installation ID, as returned when the account connected

Formatuuid

Request Body

application/json
  1. body

Trigger a sync.

resource_ids?array<string>|

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_all?Sync All

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.

Defaultfalse

Response Body

Queued and skipped resources

application/json
  1. response

Response containing the outcome of triggering a sync.

data*

Queued and skipped resources

Example Request
cURL
curl -X POST https://api.mixedbread.com/v1/integrations/installations/2f1c9a8e-6b4d-4e3a-9c1f-7d8e5b6a4c21/sync \  -H 'Content-Type: application/json' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -d '{    "sync_all": true  }'
Example Response
{  "data": {    "installation_id": "2f1c9a8e-6b4d-4e3a-9c1f-7d8e5b6a4c21",    "store_id": "5d3e7f9a-1b2c-4d6e-8f0a-9c8b7a6d5e4f",    "sync_all": true,    "selected_resource_aliases": [      "all_mail"    ],    "queued_resource_ids": [      "all_mail"    ],    "skipped_resources": {}  }}