Sync Installation

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

Authorization

Authorizationstringrequired

Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`

Path Parameters

installation_idstring(uuid)required

Installation ID, as returned when the account connected

Request Body

resource_idsstring[]

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_allbooleandefault: false

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 Body

Request

cURL

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

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
  }'

Response

JSON

{
  "data": {
    "installation_id": "2f1c9a8e-6b4d-4e3a-9c1f-7d8e5b6a4c21",
    "store_id": "5d3e7f9a-1b2c-4d6e-8f0a-9c8b7a6d5e4f",
    "sync_all": true,
    "queued_resource_ids": [
      "__gmail_all_mail__"
    ],
    "skipped_resources": {}
  }
}