POST /user/items/remove
This endpoint is used to delete Items for a given User. Either a user_id or user_token must be provided. If any of the Items are not associated with the provided User, an error will be returned, and no Items will be deleted.
This is equivalent to calling /item/remove on each Item, but this endpoint supports User-based use cases (CRA) where /item/remove is not supported. To obtain a list of Items associated with a User, call /user/items/get. After an Item is deleted, it will no longer appear in /user/items/get. Item deletion via /user/items/remove will permanently and irreversibly delete the Item; to re-create the Item, send the User back through the Link flow.
This endpoint is not intended to remove all data for a User, as it will only remove items and no other data for the User. In the case of a user deleting their account with your product, call /user/products/terminate to stop billing for unneeded services. For a user initiated data deletion request, see the Consumer Service Center to revoke access to data.
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 |
|---|---|---|---|
user_token |
String | No |
The user token associated with the User data is being requested for. This field is used only by customers with pre-existing integrations that already use the |
client_id |
String | No |
Your Plaid API |
item_ids[] |
Array | Yes |
An array of |
secret |
String | No |
Your Plaid API |
user_id |
String | No |
A unique user identifier, created by |
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.