Start a bank sync

POST 
/api/v1/workspaces/:workspace_id/companies/:company_id/bank_syncs

Starts a run that pulls the company's bank data and returns it so you can poll it. A 202 never means the work finished - it means the run exists. Poll GET /api/v1/bank_syncs/{id} until state is terminal, and read terminal failure off the run rather than assuming success from the 202. The run covers every connection the company has, and takes no request body; only one may be in flight per company at a time.

Request

Responses

202

The run was accepted and is yours to poll. Nothing has been synced yet.

422

The request was refused. code says which of two: validation_failed - the Idempotency-Key header is missing; sync_in_progress - a run already owns the slot for this company, so wait for it rather than starting another.