Update Preferences

v1.0.0

This endpoint is used to update preferences like data extracts and auto refreshes without triggering refresh for the providerAccount.
Setting isDataExtractsEnabled to false will not trigger data extracts notification and dataExtracts/events will not reflect any data change that is happening for the providerAccount.
Modified data will not be provided in the dataExtracts/userData endpoint.
Setting isAutoRefreshEnabled to false will not trigger auto refreshes for the provider account.

Input

{
  "type": "object",
  "properties": {
    "preferences": {
      "type": "object",
      "properties": {
        "isAutoRefreshEnabled": {
          "type": "boolean",
          "description": "Indicates if auto-refreshes have to be triggered for the provider account.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts?include=preferences</li><li>GET providerAccounts/{providerAccountId}?include=preferences</li></ul>"
        },
        "isDataExtractsEnabled": {
          "type": "boolean",
          "description": "Indicates if the updates to the provider account should be part of the data extracts event notification or the data extract data retrieval service.<br><br><b>Endpoints</b>:<ul><li>GET providerAccounts?include=preferences</li><li>GET providerAccounts/{providerAccountId}?include=preferences</li></ul>"
        },
        "linkedProviderAccountId": {
          "type": "integer",
          "format": "int64",
          "description": "LinkedproviderAccountd is a providerAccountId linked by the user to the primary provider account. <br>LinkedProviderAccountId and the providerAccountId belongs to the same institution.<br><br><b>Endpoints</b>:<ul><li>POST Provider Account</li><li>PUT Provider Account</li><li>GET Provider Accounts</li></ul>"
        }
      }
    },
    "providerAccountId": {
      "type": "integer",
      "format": "int64"
    }
  },
  "required": [
    "providerAccountId"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "additionalProperties": true
}