action plaid_item_application_scopes_update {
  label: "Update the scopes of access for a particular application"
  description: "Enable consumers to update product access on selected accounts for an application."
  provider: plaid
  method: POST
  path: "/item/application/scopes/update"
  encoding: json
  input: {
    type: "object"
    description: "ItemApplicationScopesUpdateRequest defines the request schema for `/item/application/scopes/update`"
    required: ["access_token", "application_id", "context", "scopes"]
    properties: {
      access_token: {
        type: "string"
        description: "The access token associated with the Item data is being requested for."
      }
      application_id: {
        type: "string"
        description: "This field will map to the application ID that is returned from /item/applications/list, or provided to the institution in an oauth redirect."
      }
      client_id: {
        type: "string"
        description: "Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body."
      }
      context: {
        type: "string"
        description: "An indicator for when scopes are being updated. When scopes are updated via enrollment (i.e. OAuth), the partner must send `ENROLLMENT`. When scopes are updated in a post-enrollment view, the partner must send `PORTAL`."
        enum: ["ENROLLMENT", "PORTAL"]
      }
      scopes: {
        type: "object"
        description: "The scopes object"
        properties: {
          accounts: {
            type: "array"
            items: {
              type: "object"
              description: "Allow or disallow product access by account. Unlisted (e.g. missing) accounts will be considered `new_accounts`."
              required: ["unique_id"]
              properties: {
                account_product_access: {
                  description: "Allow the application to access specific products on this account"
                  type: "object"
                }
                authorized: {
                  type: "boolean"
                  description: "Allow the application to see this account (and associated details, including balance) in the list of accounts  If unset, defaults to `true`."
                }
                unique_id: {
                  type: "string"
                  description: "The unique account identifier for this account. This value must match that returned by the data access API for this account."
                }
              }
            }
          }
          new_accounts: {
            type: "boolean"
            description: "Allow access to newly opened accounts as they are opened. If unset, defaults to `true`."
          }
          product_access: {
            type: "object"
            description: "The product access being requested. Used to or disallow product access across all accounts. If unset, defaults to all products allowed."
            properties: {
              accounts_details_transactions: {
                type: "boolean"
                description: "Allow access to \"accounts_details_transactions\". Only used by certain partners. If relevant to the partner and unset, defaults to `true`."
              }
              accounts_routing_number: {
                type: "boolean"
                description: "Allow access to \"accounts_routing_number\". Only used by certain partners. If relevant to the partner and unset, defaults to `true`."
              }
              accounts_statements: {
                type: "boolean"
                description: "Allow access to \"accounts_statements\". Only used by certain partners. If relevant to the partner and unset, defaults to `true`."
              }
              accounts_tax_statements: {
                type: "boolean"
                description: "Allow access to \"accounts_tax_statements\". Only used by certain partners. If relevant to the partner and unset, defaults to `true`."
              }
              auth: {
                type: "boolean"
                description: "Allow access to account number details. Only used by certain partners. If relevant to the partner and unset, defaults to `true`."
              }
              customers_profiles: {
                type: "boolean"
                description: "Allow access to \"customers_profiles\". Only used by certain partners. If relevant to the partner and unset, defaults to `true`."
              }
              identity: {
                type: "boolean"
                description: "Allow access to the Identity product (name, email, phone, address). Only used by certain partners. If relevant to the partner and unset, defaults to `true`."
              }
              statements: {
                type: "boolean"
                description: "Allow access to statements. Only used by certain partners. If relevant to the partner and unset, defaults to `true`."
              }
              transactions: {
                type: "boolean"
                description: "Allow access to transaction details. Only used by certain partners. If relevant to the partner and unset, defaults to `true`."
              }
            }
          }
        }
      }
      secret: {
        type: "string"
        description: "Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body."
      }
      state: {
        type: "string"
        description: "When scopes are updated during enrollment, this field must be populated with the state sent to the partner in the OAuth Login URI. This field is required when the context is `ENROLLMENT`."
      }
    }
  }
  output: {
    type: "object"
    description: "ItemApplicationScopesUpdateResponse defines the response schema for `/item/application/scopes/update`"
    required: ["request_id"]
    properties: {
      request_id: {
        type: "string"
        description: "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
      }
    }
  }
}