POST /user/remove
/user/remove deletes a user_id or user_token and and associated information, including any Items associated with the user.
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" |
Plaid-New-User-API-Enabled |
Boolean | No |
The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. Default value: false |
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 |
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.