Update Folder Sync

Replace the recurring-sync schedules of a folder's DocumentSourceSync, then re-sync now.

Same semantics as re-submitting POST /documents/import-from-source for this target's (source, path) — see service.update_document_source_sync — but addressed by the already-known root folder instead.

Authorization

JwtAuth

AuthorizationBearer <token>

In: header

Path Parameters

folder_id*Folder Id

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

schedules*array<>

Replaces the sync's whole schedule set, then re-syncs now. Pass an empty list to clear all recurring schedules (the sync target itself is kept, so files already synced stay put and a later PATCH can re-add schedules).

Response Body

`application/json`

curl -X PATCH "https://example.com/documents/folders/497f6eca-6276-4993-bfeb-53cbbbba6f08/sync" \  -H "Content-Type: application/json" \  -d '{    "schedules": [      {        "frequency": "15M"      }    ]  }'

{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",  "source_name": "string",  "connector_name": "string",  "path": "string",  "parent_folder_name": "string",  "root_folder_id": "c4e3e77b-bb45-4123-b910-281d20b8d412",  "schedules": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "frequency": "15M",      "time": "string",      "days_of_week": [],      "day_of_month": 0,      "run_at": "2019-08-24T14:15:22Z",      "timezone": "string",      "is_active": true,      "last_triggered_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "created_at": "2019-08-24T14:15:22Z",  "correlation_id": "string"}