Interface: SyncRunRequest

Defined in: packages/sdk/src/types/app-connection-types.ts:265

Properties

boardId?

optional boardId: string

Defined in: packages/sdk/src/types/app-connection-types.ts:280

When set, the run is further scoped to a single board mapping within the selected entity. Requires entityType to be set. Used by the per-mapping sync buttons in the Monday.com UI so a failure on one board does not obscure results on another.

---

dryRun?

optional dryRun: boolean

Defined in: packages/sdk/src/types/app-connection-types.ts:266

---

entityType?

optional entityType: SyncEntityType

Defined in: packages/sdk/src/types/app-connection-types.ts:273

When set, the run is scoped to a single entity type (members or records). Mode derivation, the "any direction enabled" guard, and checkpoint resets are all limited to the matching entity config.

---

recordLimit?

optional recordLimit: number

Defined in: packages/sdk/src/types/app-connection-types.ts:290

Optional preview-only cap on the number of entities the engine processes. Server enforces 1 <= recordLimit <= 200 and additionally requires dryRun: true — capped runs are the "test on a small batch" affordance and never commit writes. The server also withholds inbound checkpoint advancement so a subsequent uncapped sync replays the previewed records. Omit (or pass undefined) for the legacy uncapped behavior.

---

resetCheckpoints?

optional resetCheckpoints: boolean

Defined in: packages/sdk/src/types/app-connection-types.ts:267