POST /item/application/scopes/update

Enable consumers to update product access on selected accounts for an application.

Servers

https://production.plaid.com
https://sandbox.plaid.com

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`scopes`	Object	Yes	The scopes object
`scopes.accounts[]`	Array	No
`scopes.accounts[].unique_id`	String	Yes	The unique account identifier for this account. This value must match that returned by the data access API for this account.
`scopes.accounts[].authorized`	Boolean	No	Allow the application to see this account (and associated details, including balance) in the list of accounts If unset, defaults to `true`. Default value: true
`scopes.product_access`	Object	No	The product access being requested. Used to or disallow product access across all accounts. If unset, defaults to all products allowed.
`scopes.product_access.auth`	Boolean	No	Allow access to account number details. Only used by certain partners. If relevant to the partner and unset, defaults to `true`. Default value: true
`scopes.product_access.transactions`	Boolean	No	Allow access to transaction details. Only used by certain partners. If relevant to the partner and unset, defaults to `true`. Default value: true
`scopes.product_access.accounts_tax_statements`	Boolean	No	Allow access to "accounts_tax_statements". Only used by certain partners. If relevant to the partner and unset, defaults to `true`. Default value: true
`scopes.product_access.accounts_statements`	Boolean	No	Allow access to "accounts_statements". Only used by certain partners. If relevant to the partner and unset, defaults to `true`. Default value: true
`scopes.product_access.accounts_details_transactions`	Boolean	No	Allow access to "accounts_details_transactions". Only used by certain partners. If relevant to the partner and unset, defaults to `true`. Default value: true
`scopes.product_access.statements`	Boolean	No	Allow access to statements. Only used by certain partners. If relevant to the partner and unset, defaults to `true`. Default value: true
`scopes.product_access.identity`	Boolean	No	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`. Default value: true
`scopes.product_access.accounts_routing_number`	Boolean	No	Allow access to "accounts_routing_number". Only used by certain partners. If relevant to the partner and unset, defaults to `true`. Default value: true
`scopes.product_access.customers_profiles`	Boolean	No	Allow access to "customers_profiles". Only used by certain partners. If relevant to the partner and unset, defaults to `true`. Default value: true
`scopes.new_accounts`	Boolean	No	Allow access to newly opened accounts as they are opened. If unset, defaults to `true`. Default value: true
`context`	String	Yes	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`. Possible values: `"ENROLLMENT"` `"PORTAL"`
`client_id`	String	No	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.
`application_id`	String	Yes	This field will map to the application ID that is returned from /item/application/list, or provided to the institution in an oauth redirect.
`state`	String	No	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`.
`access_token`	String	Yes	The access token associated with the Item data is being requested for.
`secret`	String	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.