SimpleFIN

Update SimpleFIN connection

Updates the connection's name, app, enabled state, or exposed accounts. Account changes take effect on the consumer's next pull.

PUT

/destinations/simplefin/connections/{connectionId}

curl --request PUT \
  --url https://api.synci.io/api/v1/destinations/simplefin/connections/{connectionId} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "accounts": [
      {
        "financial_account_id": "<string>",
        "first_pulled_at": "<string>",
        "id": "<string>",
        "last_pulled_at": "<string>",
        "name": "<string>",
        "still_shared": "<string>"
      }
    ],
    "all_accounts": true,
    "app": "<string>",
    "claimed_at": "<string>",
    "created_at": "<string>",
    "enabled": "<string>",
    "financial_accounts": [
      "<string>"
    ],
    "health": {
      "failure_count": "<string>",
      "integrator_message": "<string>",
      "last_attempt_at": "<string>",
      "status": "<string>",
      "transient_failure_count": "<string>",
      "transient_message": "<string>"
    },
    "id": "<string>",
    "last_pulled_at": "<string>",
    "name": "<string>",
    "revoked_at": "<string>",
    "setup_token": "<string>",
    "setup_token_expires_at": "<string>",
    "status": "<string>",
    "updated_at": "<string>"
  },
  "message": "SimpleFIN connection updated."
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connectionIdintegerrequired

The SimpleFIN connection ID

Body

all_accountsboolean

Expose every financial account the user owns, including ones connected in the future. When true, financial_accounts is ignored.

appenum<string> | null

Which SimpleFIN app this connection is for (presentation only).

Available options: actual_budget, other

enabledboolean

Whether the connection is enabled. Disabled connections reject pulls.

financial_accountsinteger[] | null

IDs of the financial accounts to expose. Changes take effect on the consumer's next pull.

namestring | null

Display name for the connection.

Maximum string length: 255

Response

dataobjectrequired

Show child attributes

messagestringrequired

Still need help? Ask the team