Rename a connection and/or set its sync start date (enabled accounts only).

patch/api/v2/connections/{id}

Request

  • Base URL: https://fintable.io
  • URL: https://fintable.io/api/v2/connections/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Query parameters

workspace_idstring

Optional Workspace ID (ws_...) from GET /workspaces. Omit to act on the calculated default Workspace (the oldest one the person owns, otherwise the oldest one they belong to; is_default in GET /workspaces); omission returns validation_failed (422) only when the person belongs to no Workspace. Always a query parameter — on POST/PATCH/DELETE too; a body field never selects a Workspace. Unknown and unauthorized Workspace IDs return the standard not_found error.

Request body

namestring nullable

Requires the write scope.

sync_start_datestring date nullable

A read scope may send this field alone, and only to move the date EARLIER; clearing it (null) and moving it later both require write.

Response

A {"data": {...}} envelope.

dataobject
workspace_idstring

Public ID of the Workspace this successful response was resolved against (workspace-bound endpoints only).

Changes

No recorded changes to this operation across all 1 revision of this API.